summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-09-08 09:50:38 +0300
committerPaul Buetow <paul@buetow.org>2025-09-08 09:50:38 +0300
commitcead3ebde8f3aee0ef8677158d37f4d04c6629dc (patch)
treeeadf4928c13e4f1fd782e8e0955116a24cef1d27 /README.md
parent29b0da31acf02816ee9e8f1d5a1b9a0ad5993593 (diff)
tmux: colored LLM status with provider + stats; add start heartbeat for LSP/CLI/TUI; theme support via HEXAI_TMUX_STATUS_THEME and HEXAI_TMUX_STATUS_FG/BG; docs: update tmux options and add Helix+tmux quickstart
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9f94c2f..1be6238 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ It has got improved capabilities for Go code understanding (for example, create
* [Configuration guide](docs/configuration.md)
* [Usage examples](docs/usage.md)
+* [Helix + tmux quickstart](docs/helix-tmux-quickstart.md)
## Build and tasks
@@ -58,7 +59,17 @@ Hexai can surface live progress in tmux's status line via a user option. Add thi
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.
+- CLI updates `@hexai_status` at start (⏳ provider:model) and on completion with compact stats (↑sent, ↓recv, rpm, reqs).
+- LSP emits an initial heartbeat on client initialize and periodic compact stats (provider, model, rpm, reqs, bytes).
+- The TUI action runner sets a ready heartbeat and a completion heartbeat with stats.
- Toggle with `HEXAI_TMUX_STATUS=0` to disable (enabled by default).
+
+The status segment supports simple theming:
+
+- Preset themes:
+ - `HEXAI_TMUX_STATUS_THEME=white-on-purple` (white fg on purple/magenta bg)
+ - `HEXAI_TMUX_STATUS_THEME=black-on-yellow` (black fg on yellow bg)
+- Explicit colors: set any tmux color names or 256-color codes
+ - `HEXAI_TMUX_STATUS_FG=white`
+ - `HEXAI_TMUX_STATUS_BG=magenta` (or `colour5`, etc.)
+- If the segment is truncated, widen it: `set -g status-right-length 120`