|
| 1 | +# TODO Management |
| 2 | + |
| 3 | +The `/todos` command provides persistent TODO list management for Amazon Q CLI, allowing you to view, resume, and manage TODO lists created during chat sessions. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +TODO lists are automatically created when Q breaks down complex tasks. You can then manage these lists using the todos command: |
| 8 | + |
| 9 | +`/todos view` |
| 10 | +`/todos resume` |
| 11 | + |
| 12 | +## Commands |
| 13 | + |
| 14 | +#### `/todos view` |
| 15 | + |
| 16 | +Display and select a TODO list to view its contents, showing task descriptions and completion status. |
| 17 | + |
| 18 | +Interactive selection shows: |
| 19 | +- ✓ Completed lists (green checkmark) |
| 20 | +- ✗ In-progress lists with completion count (red X with progress) |
| 21 | + |
| 22 | +#### `/todos resume` |
| 23 | + |
| 24 | +Show an interactive menu of available TODO lists with their current progress status. Selecting a todo list will load the list back into your chat session, allowing Q to continue where it left off. |
| 25 | + |
| 26 | +#### `/clear-finished` |
| 27 | + |
| 28 | +Remove all completed TODO lists from storage. This helps clean up your workspace by removing lists where all tasks have been completed. |
| 29 | + |
| 30 | +#### `/todos delete [--all]` |
| 31 | + |
| 32 | +Delete specific TODO lists or all lists at once. |
| 33 | + |
| 34 | +`q chat todos delete` # Interactive selection to delete one list |
| 35 | +`q chat todos delete --all` # Delete all TODO lists |
| 36 | + |
| 37 | +**Options:** |
| 38 | +- `--all` - Delete all TODO lists without interactive selection |
| 39 | + |
| 40 | +## Storage |
| 41 | + |
| 42 | +TODO lists are stored locally in `.amazonq/cli-todo-lists/` directory within your current working directory. Each list is saved as a JSON file with: |
| 43 | + |
| 44 | +- Unique timestamp-based ID |
| 45 | +- Task descriptions and completion status |
| 46 | +- Context updates from completed tasks |
| 47 | +- Modified file paths |
| 48 | +- Overall list description |
| 49 | + |
| 50 | +#### Interactive Selection |
| 51 | + |
| 52 | +All commands use interactive selection allowing you to: |
| 53 | +- Navigate with arrow keys |
| 54 | +- Press Enter to select |
| 55 | +- Press Esc to cancel |
| 56 | + |
| 57 | +## Best Practices |
| 58 | + |
| 59 | +#### Managing Lists |
| 60 | + |
| 61 | +- Use `clear-finished` regularly to remove completed lists |
| 62 | +- Resume lists to continue complex multi-step tasks |
| 63 | +- View lists to check progress without resuming |
| 64 | + |
| 65 | +#### Workflow Integration |
| 66 | + |
| 67 | +- Let Q create TODO lists for complex tasks automatically |
| 68 | +- Use `resume` to pick up where you left off in previous sessions |
| 69 | +- Check `view` to see what tasks remain before resuming work |
| 70 | + |
| 71 | +#### TODO List Storage |
| 72 | + |
| 73 | +- Lists are stored in current working directory only |
| 74 | +- No automatic cleanup of old lists |
| 75 | +- No cross-directory list sharing |
| 76 | + |
| 77 | +## Troubleshooting |
| 78 | + |
| 79 | +#### No Lists Available |
| 80 | + |
| 81 | +If commands show "No to-do lists available": |
| 82 | + |
| 83 | +1. **Check directory**: Ensure you're in the directory where lists were created |
| 84 | +2. **Verify storage**: Look for `.amazonq/cli-todo-lists/` directory |
| 85 | +3. **Create lists**: Use chat sessions to create new TODO lists |
| 86 | + |
| 87 | +#### Lists Not Loading |
| 88 | + |
| 89 | +If lists exist but won't load: |
| 90 | + |
| 91 | +1. **Check permissions**: Ensure read access to `.amazonq/cli-todo-lists/` |
| 92 | +2. **Verify format**: Lists should be valid JSON files |
| 93 | +3. **Check file integrity**: Corrupted files may prevent loading |
0 commit comments