Skip to content

Commit 6062bf8

Browse files
authored
docs: Update experiment docs to contain todo lists (#2791)
1 parent b801481 commit 6062bf8

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

docs/built-in-tools.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,19 +110,19 @@ Opens the browser to a pre-filled GitHub issue template to report chat issues, b
110110

111111
This tool has no configuration options.
112112

113-
## Knowledge Tool
113+
## Knowledge Tool (experimental)
114114

115115
Store and retrieve information in a knowledge base across chat sessions. Provides semantic search capabilities for files, directories, and text content.
116116

117117
This tool has no configuration options.
118118

119-
## Thinking Tool
119+
## Thinking Tool (experimental)
120120

121121
An internal reasoning mechanism that improves the quality of complex tasks by breaking them down into atomic actions.
122122

123123
This tool has no configuration options.
124124

125-
## Todo_list Tool
125+
## TODO List Tool (experimental)
126126

127127
Create and manage TODO lists for tracking multi-step tasks. Lists are stored locally in `.amazonq/cli-todo-lists/`.
128128

docs/experiments.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,28 @@ Amazon Q CLI includes experimental features that can be toggled on/off using the
5858

5959
**When enabled:** Use `/tangent` or the keyboard shortcut to create a checkpoint and explore tangential topics. Use the same command to return to your main conversation.
6060

61+
### TODO Lists
62+
**Tool name**: `todo_list`
63+
**Command:** `/todos`
64+
**Description:** Enables Q to create and modify TODO lists using the `todo_list` tool and the user to view and manage existing TODO lists using `/todos`.
65+
66+
**Features:**
67+
- Q will automatically make TODO lists when appropriate or when asked
68+
- View, manage, and delete TODOs using `/todos`
69+
- Resume existing TODO lists stored in `.amazonq/cli-todo-lists`
70+
71+
**Usage:**
72+
```
73+
/todos clear-finished # Delete completed TODOs in your working directory
74+
/todos resume # Select and resume an existing TODO list
75+
/todos view # Select and view and existing TODO list
76+
/todos delete # Select and delete an existing TODO list
77+
```
78+
79+
**Settings:**
80+
- `chat.enableTodoList` - Enable/disable TODO list functionality (boolean)
81+
82+
6183
## Managing Experiments
6284

6385
Use the `/experiment` command to toggle experimental features:
@@ -84,11 +106,13 @@ These features are provided to gather feedback and test new capabilities. Please
84106
All experimental commands are available in the fuzzy search (Ctrl+S):
85107
- `/experiment` - Manage experimental features
86108
- `/knowledge` - Knowledge base commands (when enabled)
109+
- `/todos` - User-controlled TODO list commands (when enabled)
87110

88111
## Settings Integration
89112

90113
Experiments are stored as settings and persist across sessions:
91114
- `EnabledKnowledge` - Knowledge experiment state
92115
- `EnabledThinking` - Thinking experiment state
116+
- `EnabledTodoList` - TODO list experiment state
93117

94118
You can also manage these through the settings system if needed.

0 commit comments

Comments
 (0)