Skip to content

Commit dc78589

Browse files
foharaclaude
andcommitted
Update README to reflect current project state
- Update status to Phase 5 (Core Complete, Documentation In Progress) - Add Agent Integration to implemented features list - Remove "in progress" markers since all crates are complete - Expand Usage section with all implemented commands - Add Testing Guide to documentation links - Remove "Planned commands" section (agent-prompt is implemented) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a655323 commit dc78589

1 file changed

Lines changed: 36 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![Built with Markdown](https://img.shields.io/badge/built%20with-markdown-000000.svg?logo=markdown)](https://commonmark.org/)
1212
[![SQLite](https://img.shields.io/badge/database-SQLite-003B57.svg?logo=sqlite)](https://www.sqlite.org/)
1313

14-
**Status:** Active Development (Phase 4/5 - TUI Complete, Queries In Progress)
14+
**Status:** Active Development (Phase 5 - Core Complete, Documentation In Progress)
1515
</div>
1616

1717
## Overview
@@ -26,7 +26,7 @@ Lash is a terminal-first task management system that uses Markdown as the single
2626

2727
## What's Implemented
2828

29-
Core functionality is production-ready:
29+
All core functionality is production-ready:
3030

3131
- **Markdown Parser** - Full task file parsing with 390+ tests (67.7µs benchmark)
3232
- **Linter & Formatter** - 20 validation rules with auto-formatting (607 tests)
@@ -35,20 +35,19 @@ Core functionality is production-ready:
3535
- **Terminal UI (TUI)** - Interactive interface with 300+ Gogh color schemes
3636
- **CLI Framework** - Configuration, logging, and command execution infrastructure
3737
- **Query Commands** - List, search, show, and graph commands for exploring tasks
38-
39-
Next up: Agent integration and prompt generation
38+
- **Agent Integration** - Token-minimized prompt generation for LLM workflows
4039

4140
## Project Structure
4241

4342
```
4443
lash/
4544
├── crates/
46-
│ ├── lash-types/ # Shared types, errors, config ✅
47-
│ ├── lash-core/ # Markdown parsing & validation ✅
48-
│ ├── lash-db/ # SQLite indexing & queries ✅
49-
│ ├── lash-agent/ # Agent integration (in progress)
50-
│ ├── lash-tui/ # Terminal UI ✅
51-
│ └── lash-cli/ # CLI binary ✅
45+
│ ├── lash-types/ # Shared types, errors, config
46+
│ ├── lash-core/ # Markdown parsing & validation
47+
│ ├── lash-db/ # SQLite indexing & queries
48+
│ ├── lash-agent/ # Agent integration & prompt generation
49+
│ ├── lash-tui/ # Terminal UI
50+
│ └── lash-cli/ # CLI binary
5251
├── docs/ # Design docs & error codes
5352
└── tasks/ # Development task tracking
5453
```
@@ -178,8 +177,6 @@ The profiler tracks:
178177

179178
## Usage
180179

181-
**Implemented commands:**
182-
183180
```bash
184181
# Lint task files
185182
lash lint [PATH...]
@@ -190,8 +187,11 @@ lash format [PATH...]
190187
# Index files into database
191188
lash index
192189

190+
# Verify database consistency
191+
lash check-index
192+
193193
# List tasks (with filters)
194-
lash list [--label backend] [--status open]
194+
lash list [--label backend] [--status open] [--tree]
195195

196196
# Search tasks
197197
lash search "authentication"
@@ -200,10 +200,30 @@ lash search "authentication"
200200
lash show task-id
201201

202202
# Export dependency graph
203-
lash graph [--format dot|json]
203+
lash graph [--format dot|json|mermaid]
204+
205+
# Validate cross-file links
206+
lash check-links [--fix]
204207

205-
# Launch TUI (with optional color scheme)
208+
# Generate agent prompt for LLMs
209+
lash agent-prompt [OPTIONS]
210+
211+
# Launch TUI
206212
lash tui [--color-scheme "Nord"]
213+
214+
# Manage configuration
215+
lash config get <key>
216+
lash config set <key> <value>
217+
lash config list
218+
219+
# Generate shell completions
220+
lash completion bash|zsh|fish|powershell
221+
222+
# Explain error codes
223+
lash explain <CODE>
224+
225+
# Initialize demo project
226+
lash playground init
207227
```
208228

209229
### Color Schemes
@@ -224,17 +244,11 @@ Lash supports 300+ color schemes from the [Gogh](https://gogh-co.github.io/Gogh/
224244

225245
Popular schemes include: Nord, Dracula, Solarized Dark, Solarized Light, Monokai, Tokyo Night, Catppuccin, and Base2Tone Desert (default).
226246

227-
**Planned commands:**
228-
229-
```bash
230-
# Generate agent prompt
231-
lash agent-prompt
232-
```
233-
234247
## Documentation
235248

236249
- [Design Document](./docs/design-doc.md) - Comprehensive specification
237250
- [Error Codes](./docs/error-codes.md) - Complete error catalog
251+
- [Testing Guide](./docs/TESTING.md) - Testing documentation
238252
- [Development Tasks](./tasks/tasks.md) - Implementation roadmap
239253

240254
## Contributing
@@ -244,4 +258,3 @@ Lash is in active development. See [`tasks/tasks.md`](./tasks/tasks.md) for the
244258
## License
245259

246260
MIT OR Apache-2.0 (dual-licensed)
247-

0 commit comments

Comments
 (0)