summaryrefslogtreecommitdiff
path: root/docs/configuration.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-02-08 11:16:46 +0200
committerPaul Buetow <paul@buetow.org>2026-02-08 11:16:46 +0200
commit3698679c27896d0e77f677a769c7ac1437f7e042 (patch)
treefd9bc755901188ed9bfef9b0665f7312f0f67a6b /docs/configuration.md
parent5e825543dc55a2c649e68dce6341844ad71fa217 (diff)
add hexai-tmux-edit documentation to all doc files
Update README, build guide, configuration guide, usage guide, and tmux guide with hexai-tmux-edit popup editor documentation including supported agents, keybinding setup, flags, workflow, and configuration examples. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Diffstat (limited to 'docs/configuration.md')
-rw-r--r--docs/configuration.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 10e3c59..52e0689 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -110,6 +110,35 @@ See the [tmux integration guide](docs/tmux.md) for details on configuring the st
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:
+- 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 \u201cSimplify and improve\u201d action:
- `simplify_system`
- `simplify_user` (uses `{{selection}}`)
+
+Hexai Tmux Edit (popup editor)
+
+- `hexai-tmux-edit` opens `$EDITOR` in a tmux popup for composing longer AI agent prompts.
+- Configure popup dimensions and agent detection patterns in the `[tmux_edit]` section:
+
+ ```toml
+ [tmux_edit]
+ popup_width = "80%"
+ popup_height = "80%"
+ # default_agent = "claude" # force agent; skip auto-detect
+ ```
+
+- Override or add agent definitions with `[[tmux_edit.agents]]` (merged with built-in defaults by name):
+
+ ```toml
+ [[tmux_edit.agents]]
+ name = "claude"
+ display_name = "Claude Code"
+ detect_pattern = "(?i)(claude|anthropic)"
+ prompt_pattern = '(?m)>\s*(.+)$'
+ clear_first = true
+ clear_keys = "C-u"
+ newline_keys = "S-Enter"
+ submit_keys = "Enter"
+ ```
+
+- Built-in agents: `claude`, `cursor`, `amp`, `aider`. See [config.toml.example](../config.toml.example) for all fields.
+- Tmux keybinding: `bind e run-shell -b "hexai-tmux-edit --pane '#{pane_id}'"`