Skip to content

Commit 640beaa

Browse files
mjunaidcaclaude
andcommitted
docs(cli): improve documentation with clearer audit trail examples
- Clarify difference between audit IDs and task IDs - Add "Understanding Audit IDs vs Task IDs" section - Document two types of notes (description vs progress notes) - Add demo --no-cleanup to command reference - Include interactive mode shortcuts (taskflow i) - Add due dates commands reference - Better examples showing audit list --task workflow - Add Running the Demo section 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent d86bc21 commit 640beaa

2 files changed

Lines changed: 132 additions & 25 deletions

File tree

packages/cli/docs/README.md

Lines changed: 130 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ taskflow add "Review authentication module"
1414
# Start working on it
1515
taskflow start 1
1616

17-
# Update progress
17+
# Update progress with a note
1818
taskflow progress 1 --percent 50 --note "Checking OAuth flow"
1919

2020
# Complete the task
2121
taskflow complete 1
22+
23+
# View the audit trail for this task
24+
taskflow audit list --task 1
2225
```
2326

2427
## Core Concepts
@@ -40,19 +43,21 @@ taskflow worker add @claude-code --type agent --name "Claude Code" --agent-type
4043

4144
### Audit Trail
4245

43-
Every action creates an audit log entry:
46+
Every action creates an audit log entry. The audit system tracks WHO did WHAT, WHEN, and WHY.
4447

4548
```bash
4649
# View all audit logs
4750
taskflow audit list
4851

49-
# View logs for a specific task
52+
# View audit entries for a specific TASK (most common use case)
5053
taskflow audit list --task 1
5154

52-
# View a specific audit entry
53-
taskflow audit show 1
55+
# View a specific audit entry by its ID (to see full details including notes)
56+
taskflow audit show 12
5457
```
5558

59+
**Important:** `audit show <id>` shows an audit entry by **audit log ID**, not task ID. To find audit entries for a task, first run `audit list --task <id>` to see the audit IDs, then use `audit show <audit-id>` to see details.
60+
5661
### Projects
5762

5863
Tasks belong to projects for organization:
@@ -78,6 +83,7 @@ taskflow add "New feature" --project myproject
7883
| `taskflow init --user @myname` | Initialize with custom default user |
7984
| `taskflow init --path /custom/path` | Initialize in specific directory |
8085
| `taskflow demo` | Run interactive demo showcasing human-agent parity |
86+
| `taskflow demo --no-cleanup` | Run demo and keep the data for exploration |
8187
| `taskflow status` | Show current TaskFlow status |
8288

8389
### Task Management
@@ -89,6 +95,7 @@ taskflow add "New feature" --project myproject
8995
| `taskflow show <id>` | Show task details |
9096
| `taskflow edit <id>` | Edit task properties |
9197
| `taskflow delete <id>` | Delete a task |
98+
| `taskflow search <keyword>` | Search tasks by keyword |
9299

93100
#### Task Options
94101

@@ -115,19 +122,29 @@ taskflow edit 1 \
115122
|---------|-------------|
116123
| `taskflow start <id>` | Start working on a task (pending → in_progress) |
117124
| `taskflow progress <id> --percent N` | Update task progress (0-100) |
125+
| `taskflow progress <id> --percent N --note "..."` | Update progress with a note |
118126
| `taskflow review <id>` | Submit task for review |
119127
| `taskflow complete <id>` | Mark task as completed |
120128
| `taskflow block <id>` | Mark task as blocked |
121129
| `taskflow unblock <id>` | Unblock a task |
130+
| `taskflow delegate <id> --to @worker` | Reassign task to another worker |
122131

123132
#### Progress Notes
124133

134+
Progress notes are stored in the audit trail, creating a work journal:
135+
125136
```bash
126137
# Update progress with a note
127-
taskflow progress 1 --percent 75 --note "Auth flow working, testing edge cases"
128-
```
138+
taskflow progress 1 --percent 25 --note "Started code review"
139+
taskflow progress 1 --percent 50 --note "Found issue in auth logic"
140+
taskflow progress 1 --percent 75 --note "Fixed issue, running tests"
141+
142+
# View all progress notes for a task
143+
taskflow audit list --task 1
129144

130-
Progress notes are stored in the audit trail, creating a work journal.
145+
# View full details of a specific audit entry (including the note)
146+
taskflow audit show 12
147+
```
131148

132149
### Worker Management
133150

@@ -163,27 +180,64 @@ taskflow worker add @claude-code \
163180

164181
### Audit Trail
165182

183+
The audit trail records every action taken in TaskFlow.
184+
166185
| Command | Description |
167186
|---------|-------------|
168187
| `taskflow audit list` | List all audit entries |
169-
| `taskflow audit list --task <id>` | Filter by task |
170-
| `taskflow audit list --actor @id` | Filter by actor |
188+
| `taskflow audit list --task <id>` | Show audit entries for a specific task |
189+
| `taskflow audit list --actor @id` | Filter by who performed the action |
171190
| `taskflow audit list --project <slug>` | Filter by project |
172-
| `taskflow audit show <id>` | Show audit entry details |
191+
| `taskflow audit show <audit-id>` | Show full details of an audit entry |
192+
193+
#### Understanding Audit IDs vs Task IDs
194+
195+
```bash
196+
# Step 1: Find audit entries for task #3
197+
taskflow audit list --task 3
198+
# Output shows audit IDs: 9, 10, 11, 12
199+
200+
# Step 2: View details of a specific audit entry
201+
taskflow audit show 12
202+
# Shows full context including notes, status changes, etc.
203+
```
173204

174205
### Interactive Mode
175206

207+
Interactive mode provides a REPL for faster command entry:
208+
176209
```bash
177-
# Enter interactive REPL
210+
# Enter interactive mode
178211
taskflow interactive
212+
# Or use the shorthand
213+
taskflow i
179214

180215
# In interactive mode, commands work without 'taskflow' prefix:
181216
taskflow> list
182217
taskflow> add "New task"
183218
taskflow> start 1
219+
taskflow> progress 1 --percent 50 --note "Working on it"
220+
taskflow> audit list --task 1
184221
taskflow> exit
185222
```
186223

224+
Special interactive commands:
225+
- `use <project>` - Set current project context
226+
- `whoami` - Show current worker
227+
- `whoami @worker` - Set current worker context
228+
- `help` - Show available commands
229+
- `exit` / `quit` / `q` - Exit interactive mode
230+
231+
### Due Dates
232+
233+
| Command | Description |
234+
|---------|-------------|
235+
| `taskflow add "title" --due 2025-12-31` | Create task with due date |
236+
| `taskflow due <id> --date 2025-12-31` | Set due date on existing task |
237+
| `taskflow due <id> --clear` | Remove due date |
238+
| `taskflow upcoming` | Show tasks with upcoming due dates |
239+
| `taskflow overdue` | Show overdue tasks |
240+
187241
## Task Status Flow
188242

189243
```
@@ -201,25 +255,44 @@ Valid transitions:
201255

202256
## Adding Notes to Tasks
203257

204-
### Task Description (persistent)
258+
TaskFlow supports two types of notes:
259+
260+
### 1. Task Description (persistent, editable)
261+
262+
The description is attached to the task itself:
205263

206264
```bash
207-
# On creation
265+
# Set description on creation
208266
taskflow add "Implement auth" --description "Need OAuth2 with refresh tokens"
209267

210-
# On edit
211-
taskflow edit 1 --description "Updated requirements"
268+
# Update description later
269+
taskflow edit 1 --description "Updated: Also need PKCE support"
270+
271+
# View description
272+
taskflow show 1
212273
```
213274

214-
View with `taskflow show <id>`.
275+
### 2. Progress Notes (audit trail, timestamped history)
215276

216-
### Progress Notes (audit trail)
277+
Progress notes create a work journal in the audit trail:
217278

218279
```bash
219-
taskflow progress 1 --percent 50 --note "Completed initial review"
280+
# Add notes as you work
281+
taskflow progress 1 --percent 25 --note "Started implementation"
282+
taskflow progress 1 --percent 50 --note "OAuth flow working"
283+
taskflow progress 1 --percent 75 --note "Adding PKCE, found edge case"
284+
taskflow progress 1 --percent 100 --note "All tests passing"
285+
286+
# View the work journal
287+
taskflow audit list --task 1
288+
289+
# See full details of any entry
290+
taskflow audit show 15
220291
```
221292

222-
View with `taskflow audit list --task 1`.
293+
**When to use which:**
294+
- **Description**: Requirements, acceptance criteria, context that may change
295+
- **Progress notes**: Work log, decisions made, issues found, timestamps
223296

224297
## Subtasks (Recursive Tasks)
225298

@@ -229,10 +302,19 @@ Tasks can have subtasks for hierarchical decomposition:
229302
# Create parent task
230303
taskflow add "Build authentication system"
231304

232-
# Create subtasks
305+
# Create subtasks using --parent flag
233306
taskflow add "Implement login form" --parent 1
234307
taskflow add "Add OAuth provider" --parent 1
235308
taskflow add "Write auth tests" --parent 1
309+
310+
# Or use the subtask command
311+
taskflow subtask 1 "Implement logout"
312+
313+
# View task with its subtasks
314+
taskflow show 1
315+
316+
# View as a tree
317+
taskflow show 1 --tree
236318
```
237319

238320
## Environment Variables
@@ -248,7 +330,8 @@ TaskFlow stores data in `.taskflow/` directory:
248330
```
249331
.taskflow/
250332
├── config.json # Configuration (current user, default project)
251-
└── data.json # All data (projects, workers, tasks, audit logs)
333+
├── data.json # All data (projects, workers, tasks, audit logs)
334+
└── history.txt # Interactive mode command history
252335
```
253336

254337
## Examples
@@ -263,15 +346,15 @@ taskflow list
263346
# Start a task
264347
taskflow start 1
265348

266-
# Work and update progress
349+
# Work and update progress with notes
267350
taskflow progress 1 --percent 25 --note "Started code review"
268351
taskflow progress 1 --percent 50 --note "Found issue in auth logic"
269352
taskflow progress 1 --percent 75 --note "Fixed issue, running tests"
270353

271354
# Complete
272355
taskflow complete 1
273356

274-
# Review what was done
357+
# Review what was done (view the work journal)
275358
taskflow audit list --task 1
276359
```
277360

@@ -290,6 +373,9 @@ taskflow add "Update docs" --assign @alex
290373

291374
# Check who's doing what
292375
taskflow list
376+
377+
# See what a specific person has done
378+
taskflow audit list --actor @sarah
293379
```
294380

295381
### Project Organization
@@ -305,4 +391,24 @@ taskflow add "Add rate limiting" --project api
305391

306392
# List tasks by project
307393
taskflow list --project auth
394+
395+
# See all activity in a project
396+
taskflow audit list --project auth
397+
```
398+
399+
### Running the Demo
400+
401+
The demo showcases human-agent parity:
402+
403+
```bash
404+
# Run demo (cleans up after)
405+
taskflow demo
406+
407+
# Run demo and keep data for exploration
408+
taskflow demo --no-cleanup
409+
410+
# After demo, explore the data
411+
taskflow list
412+
taskflow audit list
413+
taskflow show 1
308414
```

packages/cli/quickstart.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ Demo first
1313
```>> start 3```
1414
```>> progress 3 --percent 50```
1515
```>> complete 3```
16+
```>> audit list --task 3```
1617

1718
```>>add "Review PR #42" --description "Check authentication logic and error handling"```
1819
```>>edit 3 --description "Updated requirements based on feedback" ```
1920
```>>start 4```
2021
```>>progress 4 --percent 50 --note "Completed initial review, waiting for tests"```
21-
22+
2223

2324
taskflow> # View a task
2425
taskflow> show 3

0 commit comments

Comments
 (0)