Skip to content

docs(config): fix claude examples to use claude-agent-acp #829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
feiyun968-agent wants to merge 3 commits into
base: main
Choose a base branch
from
+13 −8
Open

docs(config): fix claude examples to use claude-agent-acp #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61cef13
docs(config): fix claude examples to use claude-agent-acp
feiyun968-agent May 16, 2026
7ee670c
docs(config): use neutral env example
shaun-agent May 16, 2026
4dcbeed
docs(config): address review feedback on claude auth examples
feiyun968-agent May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions config.toml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,18 @@ args = ["acp", "--trust-all-tools"]
working_dir = "/home/agent"

# [agent]
# command = "claude"
# args = ["--acp"]
# command = "claude-agent-acp"
# args = []
# working_dir = "/home/node"
# # Install the adapter first (requires Node >= 20):
# # npm install -g @anthropic-ai/claude-code @agentclientprotocol/claude-agent-acp
# # Auth: kubectl exec -it deploy/openab-claude -- claude auth login
# # (credentials persist in HOME PVC across restarts; see docs/claude-code.md)
# ⚠️ SECURITY WARNING: Any env var listed here is accessible to the agent.
# A user could trick the agent into leaking these values via prompt injection.
# All supported backends support OAuth login — prefer that over env var API keys.
# Note: env vars here can override baseline vars (HOME, PATH, USER) if needed.
# env = { ANTHROPIC_API_KEY = "${ANTHROPIC_API_KEY}" }
# env = {}
#
# By default, the agent subprocess only inherits these baseline vars:
# Linux/macOS: HOME, PATH, USER
Expand Down
11 changes: 6 additions & 5 deletions docs/config-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ The AI agent subprocess that OpenAB spawns to handle messages via ACP.

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| `command` | string | *required* | Agent binary (e.g. `kiro-cli`, `claude`, `codex`, `gemini`, `copilot`, `opencode`, `cursor-agent`). |
| `command` | string | *required* | Agent binary (e.g. `kiro-cli`, `claude-agent-acp`, `codex`, `gemini`, `copilot`, `opencode`, `cursor-agent`). |
| `args` | string[] | `[]` | CLI arguments passed to the agent. |
| `working_dir` | string | `"/tmp"` | Working directory for the agent process. |
| `env` | map | `{}` | Extra environment variables (e.g. `{ ANTHROPIC_API_KEY = "${ANTHROPIC_API_KEY}" }`). |
| `env` | map | `{}` | Extra environment variables (e.g. `{ OPENAI_API_KEY = "${OPENAI_API_KEY}" }`). |
| `inherit_env` | string[] | `[]` | Env var names to inherit from the OAB process (e.g. vars injected via K8s `envFrom`). Keys in `env` take precedence. |

> **Default inherited vars:** After `env_clear()`, the agent always receives `HOME`, `PATH`, and `USER` (on Windows: `USERPROFILE`, `USERNAME`, `PATH`, `SystemRoot`, `SystemDrive`). Use `inherit_env` to pass additional vars beyond this baseline.
Expand All @@ -105,10 +105,11 @@ working_dir = "/home/agent"

# Claude Code
[agent]
command = "claude"
args = ["--acp"]
command = "claude-agent-acp"
args = []
working_dir = "/home/node"
env = { ANTHROPIC_API_KEY = "${ANTHROPIC_API_KEY}" }
# Auth: kubectl exec -it deploy/openab-claude -- claude auth login
# Credentials persist in HOME PVC across restarts. See docs/claude-code.md.

# Codex
[agent]
Expand Down
Loading