summaryrefslogtreecommitdiff
path: root/docs/configuration.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-09-06 10:25:36 +0300
committerPaul Buetow <paul@buetow.org>2025-09-06 10:25:36 +0300
commit5be9532cfa630f4aacd8d879c3e4f5cc316da0fa (patch)
tree0a901680fccd1e2703ffdbd9284ccff932be1d67 /docs/configuration.md
parent70f1d0e78c57dfa5beae779b3d392b6e6fa44c14 (diff)
feat(lsp): configurable inline/chat triggers; switch inline markers to >text>/>>text>; update docs and example config; tests updated to new triggers and raise LSP coverage to >=85%; chore: remove semicolon legacy; chore(mage): auto-refresh coverage daily if docs/coverage.out is older than 24h
Diffstat (limited to 'docs/configuration.md')
-rw-r--r--docs/configuration.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index e5e7dfa..3b862af 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -21,6 +21,10 @@ The config file is optional.
"completion_throttle_ms": 0,
"no_disk_io": true,
"trigger_characters": [".", ":", "/", "_", " " ],
+ "inline_open": ">",
+ "inline_close": ">",
+ "chat_suffix": ">",
+ "chat_prefixes": ["?", "!", ":", ";"],
"coding_temperature": 0.2,
"provider": "ollama",
"copilot_model": "gpt-4o-mini",
@@ -47,9 +51,29 @@ Key fields:
- manual_invoke_min_prefix: minimum typed identifier chars required for manual invoke to proceed without structural triggers (0 allows always).
- no_disk_io: avoid reading files from disk when building context.
- trigger_characters: LSP completion trigger characters.
+- inline_open / inline_close: characters that bracket inline prompts (default `>`/`>`). Inline prompts support `>text>` and a double-open variant `>>text>`. Single-character markers are required.
+- chat_suffix / chat_prefixes: in-editor chat triggers (default suffix `>` and prefixes `["?","!",":",";"]`). A line ending with one of these prefixes immediately followed by the suffix triggers a chat reply (e.g., `What?>`). Prefixes must be single characters.
- coding_temperature: optional override for LSP calls.
- provider: `openai` | `copilot` | `ollama`.
+### Trigger customization
+
+Defaults use `>` for inline prompts and chat suffix. You can change them, e.g.:
+
+```json
+{
+ "inline_open": "<",
+ "inline_close": ">",
+ "chat_suffix": "/",
+ "chat_prefixes": ["?", "!"],
+ "trigger_characters": [".", ":", "/", "_", " "]
+}
+```
+
+Notes:
+- `inline_open`/`inline_close` must be single characters; `>>text>` is the double‑open variant.
+- `chat_prefixes` items must be single characters.
+
## Environment overrides
- All config-file options can be overridden by environment variables prefixed with `HEXAI_`.
@@ -59,6 +83,8 @@ Key fields:
- `HEXAI_CODING_TEMPERATURE`
- `HEXAI_COMPLETION_DEBOUNCE_MS`, `HEXAI_COMPLETION_THROTTLE_MS`
- `HEXAI_TRIGGER_CHARACTERS` (comma-separated, e.g., `".,:,_ , "`)
+ - `HEXAI_INLINE_OPEN`, `HEXAI_INLINE_CLOSE`
+ - `HEXAI_CHAT_SUFFIX`, `HEXAI_CHAT_PREFIXES` (comma-separated)
- `HEXAI_OPENAI_MODEL`, `HEXAI_OPENAI_BASE_URL`, `HEXAI_OPENAI_TEMPERATURE`
- `HEXAI_COPILOT_MODEL`, `HEXAI_COPILOT_BASE_URL`, `HEXAI_COPILOT_TEMPERATURE`
- `HEXAI_OLLAMA_MODEL`, `HEXAI_OLLAMA_BASE_URL`, `HEXAI_OLLAMA_TEMPERATURE`