summaryrefslogtreecommitdiff
path: root/docs/usage.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-04-08 09:58:02 +0300
committerPaul Buetow <paul@buetow.org>2026-04-08 09:58:02 +0300
commit8e351c86502cea78f1f0b3aa19cde7ca702bacab (patch)
tree1340e27219255b0ebe49bdbe3b5c2fbd95df8810 /docs/usage.md
parent9e8f558a1f6fcdb09a8a02dfcd2e3d8fc9ce613f (diff)
Rename task CLI from ask to do
- Move cmd/ask to cmd/do; mage BuildDo builds binary named do - Update askcli help text, errors, Fish completion (complete -c do, __do_*) - Task alias cache path: XDG cache hexai/do/task-aliases-v2.json - Refresh README and docs; go install path cmd/do@latest - Remove accidentally tracked cmd/ask build artifact; ignore cmd/do/do and cmd/do/ask Made-with: Cursor
Diffstat (limited to 'docs/usage.md')
-rw-r--r--docs/usage.md84
1 files changed, 42 insertions, 42 deletions
diff --git a/docs/usage.md b/docs/usage.md
index 0786a00..cc78300 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -125,77 +125,77 @@ cat SOMEFILE.txt | hexai --tps-simulation 20
## Task management
-`ask` is a task management CLI for the current git project. By default it auto-scopes to `project:<repo> +agent` so operations are confined to agent-managed project tasks.
+`do` is a task management CLI for the current git project. By default it auto-scopes to `project:<repo> +agent` so operations are confined to agent-managed project tasks.
-Use `ask na <subcommand...>` or `ask no-agent <subcommand...>` to run the same subcommands against project tasks without the `+agent` tag. Those prefixes keep the project scope but replace the default tag filter with `-agent`.
+Use `do na <subcommand...>` or `do no-agent <subcommand...>` to run the same subcommands against project tasks without the `+agent` tag. Those prefixes keep the project scope but replace the default tag filter with `-agent`.
-`ask` never exposes Taskwarrior numeric task IDs. Human-facing output uses stable local alias IDs where practical, while `ask info` shows both the alias ID and the UUID. Commands that accept a task selector support either the alias ID or the UUID.
+`do` never exposes Taskwarrior numeric task IDs. Human-facing output uses stable local alias IDs where practical, while `do info` shows both the alias ID and the UUID. Commands that accept a task selector support either the alias ID or the UUID.
-`ask` must be run inside a git repository so the project name can be derived from the repo root.
+`do` must be run inside a git repository so the project name can be derived from the repo root.
### Subcommands
| Subcommand | Description |
|---|---|
-| `ask add "description"` | Create a new task and print `created task <alias-id>` |
-| `ask add depends:<id\|uuid>,<id\|uuid> "description"` | Create task with inline dependencies |
-| `ask add priority:H "description"` | Create task with priority |
-| `ask add +tag "description"` | Create task with tag |
-| `ask na add "description"` | Create a project task without the `+agent` tag |
-| `ask list` | List pending tasks only (alias-ID table) |
-| `ask na list` | List pending project tasks without the `+agent` tag |
-| `ask all` | List all tasks including completed/deleted |
-| `ask list +READY` | List only ready tasks |
-| `ask list +BLOCKED` | List blocked tasks |
-| `ask list +tag` | Filter by tag |
-| `ask list started` | List started tasks |
-| `ask list limit:N` | Limit results |
-| `ask list sort:priority-,urgency-` | Sort by priority then urgency |
-| `ask info [id\|uuid]` | Show task details, or the current started task if no selector is provided |
-| `ask annotate <id\|uuid> "note"` | Add annotation |
-| `ask start <id\|uuid>` | Start working on a task |
-| `ask stop <id\|uuid>` | Stop work on a task |
-| `ask done <id\|uuid>` | Mark task complete |
-| `ask priority <id\|uuid> H\|M\|L` | Set priority |
-| `ask tag <id\|uuid> +tag` | Add tag |
-| `ask tag <id\|uuid> -tag` | Remove tag |
-| `ask dep add <id\|uuid> <dep-id\|dep-uuid>` | Add dependency |
-| `ask dep rm <id\|uuid> <dep-id\|dep-uuid>` | Remove dependency |
-| `ask dep list <id\|uuid>` | List dependencies |
-| `ask urgency` | List tasks by urgency |
-| `ask modify <id\|uuid> <args...>` | General-purpose modify |
-| `ask denotate <id\|uuid> "text"` | Remove annotation |
-| `ask delete <id\|uuid>` | Delete a task |
+| `do add "description"` | Create a new task and print `created task <alias-id>` |
+| `do add depends:<id\|uuid>,<id\|uuid> "description"` | Create task with inline dependencies |
+| `do add priority:H "description"` | Create task with priority |
+| `do add +tag "description"` | Create task with tag |
+| `do na add "description"` | Create a project task without the `+agent` tag |
+| `do list` | List pending tasks only (alias-ID table) |
+| `do na list` | List pending project tasks without the `+agent` tag |
+| `do all` | List all tasks including completed/deleted |
+| `do list +READY` | List only ready tasks |
+| `do list +BLOCKED` | List blocked tasks |
+| `do list +tag` | Filter by tag |
+| `do list started` | List started tasks |
+| `do list limit:N` | Limit results |
+| `do list sort:priority-,urgency-` | Sort by priority then urgency |
+| `do info [id\|uuid]` | Show task details, or the current started task if no selector is provided |
+| `do annotate <id\|uuid> "note"` | Add annotation |
+| `do start <id\|uuid>` | Start working on a task |
+| `do stop <id\|uuid>` | Stop work on a task |
+| `do done <id\|uuid>` | Mark task complete |
+| `do priority <id\|uuid> H\|M\|L` | Set priority |
+| `do tag <id\|uuid> +tag` | Add tag |
+| `do tag <id\|uuid> -tag` | Remove tag |
+| `do dep add <id\|uuid> <dep-id\|dep-uuid>` | Add dependency |
+| `do dep rm <id\|uuid> <dep-id\|dep-uuid>` | Remove dependency |
+| `do dep list <id\|uuid>` | List dependencies |
+| `do urgency` | List tasks by urgency |
+| `do modify <id\|uuid> <args...>` | General-purpose modify |
+| `do denotate <id\|uuid> "text"` | Remove annotation |
+| `do delete <id\|uuid>` | Delete a task |
### Examples
```sh
# Create a task
-ask add priority:H "Implement new feature"
+do add priority:H "Implement new feature"
# Create a non-agent task
-ask na add "Follow up manually"
+do na add "Follow up manually"
# Create a task with dependencies
-ask add +cli depends:0,1 "Implement dependent feature"
+do add +cli depends:0,1 "Implement dependent feature"
# List tasks
-ask list +READY limit:5
+do list +READY limit:5
# List non-agent tasks
-ask no-agent list
+do no-agent list
# Show alias and UUID for a task
-ask info 0
+do info 0
# Show a non-agent task
-ask na info 0
+do na info 0
# Start working
-ask start 0
+do start 0
# Done
-ask done 0
+do done 0
```
## Hexai Action (TUI)