summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-04-26 09:05:36 +0300
committerPaul Buetow <paul@buetow.org>2026-04-26 09:05:36 +0300
commit017b355d6632ef9fbf162fa741e7dde366b2b2db (patch)
treeee23cbde7c06cdff659820565b13be608eed49aa /docs
parent4e59e25a4304a674a7c970bc371640cf0f73d3fd (diff)
feat: default to Ollama Cloud (kimi-k2.6) when no provider configured
Switches the in-code defaults so that hexai talks to Ollama Cloud (https://ollama.com) with model kimi-k2.6 when no provider is configured, instead of OpenAI. The example config, README, and configuration guide all reflect the new recommended setup; previous OpenAI / local-Ollama options are still documented as alternatives. Tests that depended on the implicit "openai" default now pin the provider explicitly so they continue to exercise the OpenAI / gpt-5 code paths they were designed to cover. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 06cc9fc..573d8e7 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -65,20 +65,22 @@ Runtime reloads
API keys:
+- Ollama Cloud (recommended default): prefer `HEXAI_OLLAMA_API_KEY`, falling back to `OLLAMA_API_KEY`. The key is optional — leave it unset to talk to a local Ollama server.
- OpenAI: prefer `HEXAI_OPENAI_API_KEY`, falling back to `OPENAI_API_KEY`.
- OpenRouter: prefer `HEXAI_OPENROUTER_API_KEY`, falling back to `OPENROUTER_API_KEY`.
+- Anthropic: prefer `HEXAI_ANTHROPIC_API_KEY`, falling back to `ANTHROPIC_API_KEY`.
Selecting a provider
-- Sectioned: set `[provider] name = "openai" | "openrouter" | "anthropic" | "ollama"`.
-- If omitted, Hexai defaults to `openai`.
+- Sectioned: set `[provider] name = "ollama" | "openai" | "openrouter" | "anthropic"`.
+- If omitted, Hexai defaults to `ollama` (Ollama Cloud at `https://ollama.com` with model `kimi-k2.6`).
- Selecting `openrouter` uses https://openrouter.ai/api/v1 by default and automatically sends the required `HTTP-Referer` (`https://github.com/snonux/hexai`) and `X-Title` (`Hexai`) headers. Override the base URL via `[openrouter]` or environment variables when needed.
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.
+- The default Ollama base URL is `https://ollama.com` (Ollama Cloud). Set `HEXAI_OLLAMA_API_KEY` (or `OLLAMA_API_KEY`) to authenticate.
+- To use a local Ollama server instead, set `[ollama] base_url = "http://localhost:11434"` and pick a locally pulled model (e.g. `ollama pull qwen3-coder:30b-a3b-q4_K_M`). No API key is required when targeting localhost.
+- Alternatively, run Ollama in OpenAI‑compatible mode and use the OpenAI provider with `openai_base_url` pointed at your local endpoint.
Hexai Action (TUI) configuration