summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-09-07 21:11:58 +0300
committerPaul Buetow <paul@buetow.org>2025-09-07 21:11:58 +0300
commit09abc655577fb7cf03cd830c2f6a2fee43d1ae2a (patch)
tree4beb4b0ef807b7ed74f87d000be5f1b46226b4c6 /docs
parentb39f233bf65c4a4b1d8d7a813b21d8477699ffae (diff)
docs(tmux): document status-right setup and HEXAI_TMUX_STATUS toggle
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index e37f743..690a08f 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -62,6 +62,21 @@ Editor integration
- Editor resolution: `HEXAI_EDITOR`, falling back to `EDITOR` when unset.
- Invocation form: `EDITOR /tmp/hexai-XXXX.md` (a temporary Markdown file).
+Tmux status line
+
+- Hexai can update a tmux user option during LLM activity. Add this to your `~/.tmux.conf` to display it:
+
+ - `set -g status-right '#{@hexai_status} #[fg=colour8]| %H:%M'`
+
+- Status content is updated best‑effort at key moments:
+ - CLI: start (⏳ provider:model) and completion (✅ model duration)
+ - LSP: after logging aggregate LLM stats (LLM:model)
+ - TUI action runner: ready (model) and completion (✅ model)
+
+- Toggle via environment:
+ - Enable (default): unset or `HEXAI_TMUX_STATUS=1`
+ - Disable: `HEXAI_TMUX_STATUS=0`
+
Code action prompts
- All prompts can be customized under `[prompts.code_action]` in `config.toml`. In addition to `rewrite_*`, `diagnostics_*`, `document_*`, and `go_test_*`, the following templates control the “Simplify and improve” action: