summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-09-07 21:12:52 +0300
committerPaul Buetow <paul@buetow.org>2025-09-07 21:12:52 +0300
commit29b0da31acf02816ee9e8f1d5a1b9a0ad5993593 (patch)
treed5060fbcbb9b3abc63434117d338670e5a93c10a
parent09abc655577fb7cf03cd830c2f6a2fee43d1ae2a (diff)
docs: add tmux status-right snippet and behavior summary to README
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index a656c38..9f94c2f 100644
--- a/README.md
+++ b/README.md
@@ -49,3 +49,16 @@ Either use the Mage method as mentioned above, or install directly with:
- When invoked without arguments, `hexai` opens your editor (`$HEXAI_EDITOR` or `$EDITOR`) on a temporary `.md` file to capture a prompt, and combines it with any piped stdin.
- With arguments, behavior is unchanged (no editor spawn).
+
+## Tmux Status Line
+
+Hexai can surface live progress in tmux's status line via a user option. Add this to your `~/.tmux.conf`:
+
+```
+set -g status-right '#{@hexai_status} #[fg=colour8]| %H:%M'
+```
+
+- CLI updates `@hexai_status` at start (⏳ provider:model) and on completion (✅ model duration).
+- LSP sends a short heartbeat after logging aggregate LLM stats.
+- The TUI action runner sets a ready message and a completion message.
+- Toggle with `HEXAI_TMUX_STATUS=0` to disable (enabled by default).