From 75cf6abd55bfb60324fc47cf91eac08dbb8b87b4 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Mon, 8 Sep 2025 12:02:40 +0300 Subject: docs: move tmux documentation to its own file --- README.md | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 32ce84f..a2b1836 100644 --- a/README.md +++ b/README.md @@ -20,7 +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) +* [Helix + tmux quickstart](docs/tmux.md) ## Build and tasks @@ -53,26 +53,4 @@ Either use the Mage method as mentioned above, or install directly with: ## 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' -``` - -- Note: `colour8` is typically “bright black” (a dim grey) in many themes. - If it’s low-contrast on your background, change it (e.g., `colour7` or `white`). - -- 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` +See the [tmux integration guide](docs/tmux.md) for details on configuring the status line. -- cgit v1.2.3