summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-08-20 09:15:36 +0300
committerPaul Buetow <paul@buetow.org>2025-08-20 09:15:36 +0300
commit622587248c0b74193ab9dcc6120d583142381a9d (patch)
treed3768e4e9bd0c155acd0e988499d87dbb02c12f4
parent0025db8844e41145dace4a02d5bee60b64417c81 (diff)
clarific
-rw-r--r--README.md2
-rw-r--r--docs/configuration.md8
2 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 177dafc..888a403 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ Hexai, the AI addition for your Helix Editor (https://helix-editor.com) .. Other
* Stand-alone command line tool for LLM interaction
* Support for OpenAI, GitHub Copilot, and Ollama
-It has been coded with AI and human review.
+AI coded it under human supervision, and a human developer reviewed the code.
## Documentation
diff --git a/docs/configuration.md b/docs/configuration.md
index 6e430d1..015f4e7 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -5,6 +5,8 @@ environment overrides, provider selection, and temperature behavior.
## Config file
+The config file is optional.
+
- Location: `$XDG_CONFIG_HOME/hexai/config.json` (usually `~/.config/hexai/config.json`).
- Example:
@@ -65,7 +67,7 @@ API keys:
- Set `provider` in the config to `openai`, `copilot`, or `ollama`.
- If omitted, Hexai defaults to `openai`.
-## OpenAI configuration
+### OpenAI configuration
- Required: `HEXAI_OPENAI_API_KEY` (or `OPENAI_API_KEY`).
- Options:
@@ -73,7 +75,7 @@ API keys:
- `openai_base_url` — API base (default: `https://api.openai.com/v1`).
- `openai_temperature` — default temperature (coding-friendly `0.2`).
-## GitHub Copilot configuration
+### GitHub Copilot configuration
- Required: `COPILOT_API_KEY`.
- Options:
@@ -81,7 +83,7 @@ API keys:
- `copilot_base_url` — API base (default: `https://api.githubcopilot.com`).
- `copilot_temperature` — default temperature (coding-friendly `0.2`).
-## Ollama configuration
+### Ollama configuration
- Options:
- `ollama_model` — model name/tag (default: `qwen3-coder:30b-a3b-q4_K_M`).