summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md6
-rw-r--r--docs/usage.md1
2 files changed, 7 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 11f23c1..e37f743 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -56,6 +56,12 @@ This is mostly useful when Helix runs in a [tmux](https://tmux.github.io/) sessi
- `--tmux-percent N` split size percentage (default: `33`).
- `--ui-child` internal; used by the parent process when spawning inside tmux.
+Editor integration
+
+- Hexai tries to launch your preferred editor when needed (e.g., TUI “Custom prompt”, CLI with no args).
+- Editor resolution: `HEXAI_EDITOR`, falling back to `EDITOR` when unset.
+- Invocation form: `EDITOR /tmp/hexai-XXXX.md` (a temporary Markdown file).
+
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:
diff --git a/docs/usage.md b/docs/usage.md
index 925ac26..293b038 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -109,6 +109,7 @@ hexai 'install ripgrep on macOS and explain'
- 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`.
Input formats