diff options
| author | Paul Buetow <paul@buetow.org> | 2026-04-08 10:04:19 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-04-08 10:04:19 +0300 |
| commit | 385278639394e3672bce678b49e51f14ac72638c (patch) | |
| tree | 6602ae262d1b3d9a6b3b99e0cf61cc6c432b5bba /docs | |
| parent | 8e351c86502cea78f1f0b3aa19cde7ca702bacab (diff) | |
docs: align task CLI docs with do rename from ask
Rename plan-ask-uuid-wrapper.md to plan-do-uuid-wrapper.md and note the
former binary name. Clarify install line, README entrypoint, and usage
task-management section so scripts and examples consistently use do.
Made-with: Cursor
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/buildandinstall.md | 2 | ||||
| -rw-r--r-- | docs/plan-do-uuid-wrapper.md (renamed from docs/plan-ask-uuid-wrapper.md) | 6 | ||||
| -rw-r--r-- | docs/usage.md | 4 |
3 files changed, 8 insertions, 4 deletions
diff --git a/docs/buildandinstall.md b/docs/buildandinstall.md index abca741..379d310 100644 --- a/docs/buildandinstall.md +++ b/docs/buildandinstall.md @@ -19,7 +19,7 @@ Note: `mage lint` uses `golangci-lint`. Install via `mage devinstall` if needed. Either use the Mage method as mentioned above, or install directly with: -- Taskwarrior proxy: `go install codeberg.org/snonux/hexai/cmd/do@latest` +- Task CLI (`do`, agent-scoped Taskwarrior wrapper): `go install codeberg.org/snonux/hexai/cmd/do@latest` - CLI: `go install codeberg.org/snonux/hexai/cmd/hexai@latest` - LSP: `go install codeberg.org/snonux/hexai/cmd/hexai-lsp-server@latest` - Action runner: `go install codeberg.org/snonux/hexai/cmd/hexai-tmux-action@latest` diff --git a/docs/plan-ask-uuid-wrapper.md b/docs/plan-do-uuid-wrapper.md index 31d719b..ed4303b 100644 --- a/docs/plan-ask-uuid-wrapper.md +++ b/docs/plan-do-uuid-wrapper.md @@ -1,5 +1,7 @@ # Plan: `do` as UUID-only Taskwarrior Wrapper +The user-facing CLI binary is **`do`** (it was previously named `ask`). This document uses `do` throughout. The Go implementation package remains `internal/askcli` in the tree below. + ## Goal Rewrite the `do` command from a thin pass-through proxy into a **subcommand-based CLI** that wraps Taskwarrior. The wrapper never exposes numeric task IDs to the caller — only UUIDs. Output is minimal and machine-friendly for coding agents. @@ -81,8 +83,8 @@ If an argument looks like a bare numeric ID where a UUID is expected, reject wit ## Package Layout ``` -cmd/do/main.go — parse subcommand, dispatch to askcli -internal/askcli/ — NEW package +cmd/do/main.go — parse subcommand, dispatch to internal/askcli +internal/askcli/ — implementation package (CLI name: do) ├── dispatch.go — subcommand router (switch args[0]) ├── taskexec.go — wraps Taskwarrior execution (binary lookup, repo detection, run) ├── taskexport.go — TaskExport struct + JSON parse helper diff --git a/docs/usage.md b/docs/usage.md index cc78300..ee811a3 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -125,7 +125,9 @@ cat SOMEFILE.txt | hexai --tps-simulation 20 ## Task management -`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. +`do` is a task management CLI for the current git project. The binary was previously named `ask`; use `do` everywhere (commands, scripts, shell completion). + +By default it auto-scopes to `project:<repo> +agent` so operations are confined to agent-managed project tasks. 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`. |