diff options
| author | Paul Buetow <paul@buetow.org> | 2026-04-25 16:19:03 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-04-25 16:19:03 +0300 |
| commit | d382cdf04a867b168ebd04a5b9686b132ae0247d (patch) | |
| tree | 77b7548c336af7d7c98307498c38d9df0cfab6e5 /docs/usage.md | |
| parent | a1031b761ff0c5cd79f3f0906e5c3b33fa849f37 (diff) | |
docs: update documentation for popup, fix_typos, and configurable menu
- README: expand hexai-tmux-action bullet with popup mode, all built-in
hotkeys, configurable menu, and overridable prompts
- configuration.md: update TUI section (split→popup, new popup flags,
configurable menu example, prompt key-prefix table)
- usage.md: update Hexai Action section with full hotkey table and
configurable menu mention
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'docs/usage.md')
| -rw-r--r-- | docs/usage.md | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/usage.md b/docs/usage.md index 0429176..096b93a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -215,12 +215,23 @@ ask done 0 ## Hexai Action (TUI) -`hexai-tmux-action` runs code actions over a selection or diagnostics+selection piped from stdin, or read from a file. +`hexai-tmux-action` runs code actions over a selection or diagnostics+selection piped from stdin, or read from a file. When invoked from Helix `:pipe`, it opens a tmux popup to display the menu and returns the result on stdout. + +- Choose an action with arrow keys, `j/k`, `g/G`, Enter, or single-character hotkeys. +- Default built-in actions and hotkeys: + +| Hotkey | Action | +|---|---| +| `r` | Rewrite selection | +| `i` | Simplify and improve | +| `c` | Document code | +| `t` | Generate Go unit test(s) | +| `f` | Fix typos and improve grammar and clarity | +| `p` | Custom prompt (opens `$HEXAI_EDITOR` / `$EDITOR` on a temporary `.md` file) | +| `s` | Skip | -- Choose an action with arrow keys, `j/k`, `g/G`, Enter, or hotkeys `[s] [r] [c] [t]`. - - Includes: Rewrite selection, Simplify and improve, Document code, Generate Go unit test(s), Skip. - - “Custom prompt” (hotkey `[p]`) opens your editor (`$HEXAI_EDITOR` or `$EDITOR`) on a temporary `.md` file to write a free-form instruction. - Output is written to stdout by default, or to a file via `--outfile`. +- The menu can be fully replaced via `[[tmux_action.menu]]` in `config.toml` — see the [configuration guide](configuration.md) for details. Input formats |