diff options
| author | Paul Buetow <paul@buetow.org> | 2026-03-19 09:26:26 +0200 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-03-19 09:26:26 +0200 |
| commit | 15bc73d103259b492f8b77a422f8649bdf3d7c24 (patch) | |
| tree | 58a834d1cab371ce9acc2b25780524223c06980c /docs | |
| parent | 5642eaf74a4a70e5c82646bef3e0dd42846baea8 (diff) | |
Add ask Taskwarrior wrapper
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/buildandinstall.md | 3 | ||||
| -rw-r--r-- | docs/usage.md | 16 |
2 files changed, 18 insertions, 1 deletions
diff --git a/docs/buildandinstall.md b/docs/buildandinstall.md index 2240be0..3d70a4a 100644 --- a/docs/buildandinstall.md +++ b/docs/buildandinstall.md @@ -3,7 +3,7 @@ Hexai uses Mage for developer tasks. Install Mage, then run targets like build, dev, test, and install. - Install Mage: `go install github.com/magefile/mage@latest` -- Build binaries: `mage build` (produces `hexai`, `hexai-lsp-server`, `hexai-tmux-action`, and `hexai-tmux-edit`) +- Build binaries: `mage build` (produces `ask`, `hexai`, `hexai-lsp-server`, `hexai-tmux-action`, and `hexai-tmux-edit`) - Dev build (+ tests, vet, lint): `mage dev` - Run tests: `mage test` - Run tests with coverage: `go test ./... -cover` @@ -18,6 +18,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/ask@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/usage.md b/docs/usage.md index 8404969..571956b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -123,6 +123,22 @@ hexai --tps-simulation 12-18 cat SOMEFILE.txt | hexai --tps-simulation 20 ``` +## Taskwarrior proxy + +Use `ask` when you want Taskwarrior automatically scoped to the current git repo and the `+agent` tag. + +- `ask list` +- `ask add priority:H "Implement X"` +- `ask uuid:1234 annotate "Delivered Y"` +- `ask 42 done` + +`ask` pre-sets `project:<repo> +agent` and then forwards the remaining arguments to Taskwarrior unchanged, so normal reports, filters, UUID selectors, and commands still work. It must be run inside a git repository so the project name can be derived from the repo root. + +Compatibility note: `hexai task ...` still works and behaves the same way, but `ask ...` is the shorter preferred entrypoint for agent-managed project tasks. + +- `hexai task list` +- `hexai task uuid:1234 annotate "Delivered Y"` + ## Hexai Action (TUI) `hexai-tmux-action` runs code actions over a selection or diagnostics+selection piped from stdin, or read from a file. |