summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-08-16 14:58:03 +0300
committerPaul Buetow <paul@buetow.org>2025-08-16 14:58:03 +0300
commit1e1df8c204f6771719f85d8402128d72138bb863 (patch)
tree20508d35f86625ff5b74b509176111ffde163605 /README.md
parenta6a8b84690c50767f714b413496b5aeb45b31c21 (diff)
llm: add pluggable provider with OpenAI default; extensive logging; LSP completion integration with TextEdit, param-aware prompts; remove idle gating; label/filter improvements; docs update
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3c1d45f..8fd42bd 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,16 @@
Hexai, the AI LSP for the Helix editor.
-At the moment this project is only in the bainstorming phase.
+At the moment this project is only in the brainstorming phase.
+## LLM provider
+
+Hexai exposes a simple LLM provider interface and uses OpenAI by default for
+code completion when `OPENAI_API_KEY` is present in the environment.
+
+- Required: set `OPENAI_API_KEY` to your OpenAI API key.
+- Optional: set `OPENAI_MODEL` (default: `gpt-4o-mini`).
+- Optional: set `OPENAI_BASE_URL` to point at a compatible endpoint.
+
+If no key is configured, Hexai will fall back to a basic, local completion.