diff options
| author | Paul Buetow <paul@buetow.org> | 2025-09-07 11:26:10 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-09-07 11:26:10 +0300 |
| commit | 8889949ad3851bfbf36ff5b73128286d67c88201 (patch) | |
| tree | 0f515ae6ee3da898dea113799c09e943f3e3f8fb /docs/configuration.md | |
| parent | 7c0266e94378f6121719939c6d53915eb72eed3e (diff) | |
tiding up
Diffstat (limited to 'docs/configuration.md')
| -rw-r--r-- | docs/configuration.md | 33 |
1 files changed, 20 insertions, 13 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 3fbb1dc..dc4adbd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -30,23 +30,30 @@ API keys: Selecting a provider - Sectioned: set `[provider] name = "openai" | "copilot" | "ollama"`. -- Flat: set `provider = "openai" | "copilot" | "ollama"`. - If omitted, Hexai defaults to `openai`. -Provider-specific options - -- See [config.toml.example](../config.toml.example) for the per-provider tables and defaults. - -Notes: +Notes on Ollama: - Ensure the model is available locally (e.g., `ollama pull qwen3-coder:30b-a3b-q4_K_M`). - Alternatively, run Ollama in OpenAI‑compatible mode and use the OpenAI provider with `openai_base_url` pointed at your local endpoint. -LSP completion tuning - -- See the [completion] section in [config.toml.example](../config.toml.example). - -Temperature behavior - -- Defaults and recommended ranges are commented inline in [config.toml.example](../config.toml.example) under [general] and provider tables. +Hexai Action (TUI) configuration + +This is mostly useful when Helix runs in a [tmux](https://tmux.github.io/) session! + +- Helix integration (recommended): bind a key to pipe the current selection to `hexai-action` and replace it with the output. + - Example: `C-a = ":pipe hexai-action"` +- Default behavior: + - Inline TUI when run in a real terminal (TTY). + - When invoked via Helix `:pipe` and a tmux session is available, `hexai-action` opens a split pane to render the menu and returns the result on stdout for Helix to apply. + - If no TTY and no tmux are available, it falls back to echoing the input. +- Flags: + - `--infile` Read input from the given file instead of stdin. + - `--outfile` Write output to the given file instead of stdout (truncates/creates). + - `--tmux` force tmux-pane mode. + - `--no-tmux` disable tmux mode even if available. + - `--tmux-target` tmux target pane/window (advanced). + - `--tmux-split v|h` split orientation (default: `v`). + - `--tmux-percent N` split size percentage (default: `33`). + - `--ui-child` internal; used by the parent process when spawning inside tmux. |
