summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-03-26 22:07:07 +0200
committerPaul Buetow <paul@buetow.org>2026-03-26 22:07:07 +0200
commitb10c6247e14a3acfe20e78426e131691e205a601 (patch)
tree907bb5b3ffa8239584ae9b7c2bfc34667b095b62 /docs
parentbef3cc7dd95745a5724d3569e45fe7be4aba02ee (diff)
ask: add fish completions for task CLI
Diffstat (limited to 'docs')
-rw-r--r--docs/buildandinstall.md1
-rw-r--r--docs/fish-completion.md20
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/buildandinstall.md b/docs/buildandinstall.md
index 3d70a4a..7e63ada 100644
--- a/docs/buildandinstall.md
+++ b/docs/buildandinstall.md
@@ -11,6 +11,7 @@ Hexai uses Mage for developer tasks. Install Mage, then run targets like build,
- In restricted sandboxes/CI (no sockets), skip network-based tests:
- `HEXAI_TEST_SKIP_NET=1 go test ./... -cover`
- Install binaries to `GOPATH/bin`: `mage install`
+- Install Fish completions: `install -Dm644 assets/ask.fish ~/.config/fish/completions/ask.fish`
Note: `mage lint` uses `golangci-lint`. Install via `mage devinstall` if needed.
diff --git a/docs/fish-completion.md b/docs/fish-completion.md
new file mode 100644
index 0000000..116a0a6
--- /dev/null
+++ b/docs/fish-completion.md
@@ -0,0 +1,20 @@
+# Fish Completion
+
+Hexai ships a Fish completion file for the `ask` task-management CLI at [`assets/ask.fish`](../assets/ask.fish).
+
+It completes the top-level `ask` subcommands and the nested `ask dep` operations.
+The script also preserves the global `--json` flag.
+
+Install it into Fish's completion directory:
+
+```sh
+install -Dm644 assets/ask.fish ~/.config/fish/completions/ask.fish
+```
+
+If you use a custom XDG config directory, copy it to:
+
+```sh
+$XDG_CONFIG_HOME/fish/completions/ask.fish
+```
+
+The completion file is static and ships with the repository, so it does not require a build step.