docs(helexa-acp): README + example config for end-user onboarding
Some checks failed
CI / CUDA type-check (push) Failing after 18s
CI / Format (push) Successful in 32s
build-prerelease / Resolve version stamps (push) Successful in 35s
CI / Clippy (push) Successful in 2m36s
build-prerelease / Build cortex binary (push) Successful in 4m13s
CI / Test (push) Successful in 5m6s
CI / Build cortex SRPM (push) Has been skipped
CI / Publish cortex to COPR (push) Has been skipped
CI / Build neuron SRPM (push) Has been skipped
CI / Publish neuron to COPR (push) Has been skipped
CI / Bump version in source (push) Has been skipped
build-prerelease / Build neuron-blackwell (push) Successful in 5m40s
build-prerelease / Package cortex RPM (push) Successful in 1m19s
build-prerelease / Build neuron-ampere (push) Successful in 7m53s
build-prerelease / Build neuron-ada (push) Successful in 5m12s
build-prerelease / Package helexa-neuron-ampere RPM (push) Successful in 2m55s
build-prerelease / Package helexa-neuron-ada RPM (push) Successful in 3m4s
build-prerelease / Package helexa-neuron-blackwell RPM (push) Successful in 3m43s
build-prerelease / Publish to rpm.lair.cafe (unstable) (push) Successful in 1m0s
Some checks failed
CI / CUDA type-check (push) Failing after 18s
CI / Format (push) Successful in 32s
build-prerelease / Resolve version stamps (push) Successful in 35s
CI / Clippy (push) Successful in 2m36s
build-prerelease / Build cortex binary (push) Successful in 4m13s
CI / Test (push) Successful in 5m6s
CI / Build cortex SRPM (push) Has been skipped
CI / Publish cortex to COPR (push) Has been skipped
CI / Build neuron SRPM (push) Has been skipped
CI / Publish neuron to COPR (push) Has been skipped
CI / Bump version in source (push) Has been skipped
build-prerelease / Build neuron-blackwell (push) Successful in 5m40s
build-prerelease / Package cortex RPM (push) Successful in 1m19s
build-prerelease / Build neuron-ampere (push) Successful in 7m53s
build-prerelease / Build neuron-ada (push) Successful in 5m12s
build-prerelease / Package helexa-neuron-ampere RPM (push) Successful in 2m55s
build-prerelease / Package helexa-neuron-ada RPM (push) Successful in 3m4s
build-prerelease / Package helexa-neuron-blackwell RPM (push) Successful in 3m43s
build-prerelease / Publish to rpm.lair.cafe (unstable) (push) Successful in 1m0s
Stage 7. Walks a new user from "never heard of helexa-acp" to "chatting via Zed against helexa or a public API in 10 minutes": - crates/helexa-acp/README.md — install (from source / COPR), quick-start env-var path, multi-endpoint TOML, full Zed setup, endpoint cookbook (cortex/neuron, OpenAI, Anthropic, OpenRouter, LM Studio, multi-cortex), three session modes (Default / Bypass / Plan) with their tool tables, tool surface + path-handling rules, session resume, context compaction, troubleshooting for the five failure modes a new user is likely to hit, and architecture reference for contributors. - helexa-acp.example.toml — copy-paste-and-edit starter config at the repo root, mirroring the existing cortex.example.toml / neuron.example.toml pattern. No code changes. fmt + clippy clean as a sanity check. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
85
helexa-acp.example.toml
Normal file
85
helexa-acp.example.toml
Normal file
@@ -0,0 +1,85 @@
|
||||
# helexa-acp.example.toml — example configuration
|
||||
#
|
||||
# Copy to $XDG_CONFIG_HOME/helexa-acp/config.toml (typically
|
||||
# ~/.config/helexa-acp/config.toml) and adjust for your environment.
|
||||
#
|
||||
# helexa-acp is the ACP (Agent Client Protocol) bridge that connects
|
||||
# editors like Zed to multiple LLM endpoints. Each endpoint speaks a
|
||||
# specific wire format (openai-chat, openai-responses, or
|
||||
# anthropic-messages); helexa-acp picks the right provider at runtime
|
||||
# based on the `wire_api` field.
|
||||
#
|
||||
# Selecting a model from the editor follows the `endpoint:model`
|
||||
# syntax — e.g. `openrouter:anthropic/claude-opus-4` routes the
|
||||
# request to the `openrouter` endpoint with model
|
||||
# `anthropic/claude-opus-4`. A bare `<model>` (no colon) falls
|
||||
# through to whichever endpoint is named in `default_endpoint`.
|
||||
|
||||
default_endpoint = "helexa"
|
||||
|
||||
# Optional: override the built-in system prompt with a file of your own.
|
||||
# When unset, helexa-acp uses a concise coder prompt from src/prompt.rs.
|
||||
# `{cwd}` in the file gets substituted with the session's working
|
||||
# directory at request time.
|
||||
# system_prompt_path = "/home/me/.config/helexa-acp/system-prompt.md"
|
||||
|
||||
# ── helexa (cortex/neuron, self-hosted) ────────────────────────────
|
||||
#
|
||||
# The canonical default. Drives cortex's reverse-proxy / fleet
|
||||
# gateway, which routes to whichever neuron has the model loaded.
|
||||
# `openai-chat` works against any cortex deployment; for vision
|
||||
# models or reasoning surface, switch to `openai-responses` (cortex
|
||||
# 0.1.16+).
|
||||
|
||||
[[endpoints]]
|
||||
name = "helexa"
|
||||
base_url = "http://hanzalova.internal:31313/v1"
|
||||
wire_api = "openai-chat"
|
||||
default_model = "Qwen/Qwen3.6-27B"
|
||||
max_tokens = 8192
|
||||
# Compaction kicks in when the rolling history grows past this token
|
||||
# budget. Set to your model's context window. Disable by removing
|
||||
# the field entirely.
|
||||
context_window = 32768
|
||||
|
||||
# ── OpenRouter (proxy for OpenAI/Anthropic/Google/etc.) ────────────
|
||||
|
||||
[[endpoints]]
|
||||
name = "openrouter"
|
||||
base_url = "https://openrouter.ai/api/v1"
|
||||
wire_api = "openai-chat"
|
||||
api_key_env = "OPENROUTER_API_KEY"
|
||||
default_model = "anthropic/claude-opus-4"
|
||||
|
||||
# ── OpenAI directly (Responses API) ────────────────────────────────
|
||||
#
|
||||
# Use `openai-responses` for the o-series and any model that
|
||||
# benefits from the newer Responses API surface (web search,
|
||||
# computer use, reasoning effort, etc.).
|
||||
|
||||
[[endpoints]]
|
||||
name = "openai"
|
||||
base_url = "https://api.openai.com/v1"
|
||||
wire_api = "openai-responses"
|
||||
api_key_env = "OPENAI_API_KEY"
|
||||
default_model = "gpt-5"
|
||||
|
||||
# ── Anthropic directly ─────────────────────────────────────────────
|
||||
|
||||
[[endpoints]]
|
||||
name = "anthropic"
|
||||
base_url = "https://api.anthropic.com/v1"
|
||||
wire_api = "anthropic-messages"
|
||||
api_key_env = "ANTHROPIC_API_KEY"
|
||||
default_model = "claude-opus-4"
|
||||
|
||||
# ── Local LM Studio / Ollama (compat mode) ─────────────────────────
|
||||
#
|
||||
# Most local-LLM servers expose OpenAI-compatible chat completions.
|
||||
# Use `wire_api = "openai-chat"` and point at the local port.
|
||||
|
||||
# [[endpoints]]
|
||||
# name = "lmstudio"
|
||||
# base_url = "http://localhost:1234/v1"
|
||||
# wire_api = "openai-chat"
|
||||
# default_model = "auto"
|
||||
Reference in New Issue
Block a user