Skip to content

docs(acp): document Codex adapter selection and authentication #4711

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
onyx679 wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −3
Open

docs(acp): document Codex adapter selection and authentication #4711

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 13 additions & 3 deletions crates/buzz-acp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,23 @@ That's it. The harness spawns `goose acp`, connects to the relay, discovers chan
# Install the adapter (npm package — no Rust build required)
npm install -g @agentclientprotocol/codex-acp

# Run
export OPENAI_API_KEY="sk-..." # required — use an OpenAI API key, not a ChatGPT subscription
# Tell buzz-acp to spawn the Codex adapter instead of the default goose runtime.
export BUZZ_ACP_AGENT_COMMAND="codex-acp"

# Option A: authenticate the Codex CLI with ChatGPT (OAuth or device auth).
codex login
codex login status # should report: Logged in using ChatGPT

# Option B: use an API key instead of ChatGPT login.
# Set either CODEX_API_KEY or OPENAI_API_KEY in the environment.
export CODEX_API_KEY="sk-..."

buzz-acp
```

> **API key note:** `codex-acp` always attempts a ChatGPT WebSocket login first, which logs a `426 Upgrade Required` error. This is expected and non-fatal — it falls back to `OPENAI_API_KEY` automatically. Set `OPENAI_API_KEY` to ensure it has a working fallback.
`codex-acp` advertises both ChatGPT and API-key authentication through ACP. Use one authentication method per session: when ChatGPT login is active, an API-key variable is not required. The adapter's [authentication documentation](https://github.com/agentclientprotocol/codex-acp#authentication) covers custom gateways and the `CODEX_API_KEY`, `OPENAI_API_KEY`, and `NO_BROWSER` variables.

On Windows, run the commands from Git Bash (see the [Windows prerequisites](../../README.md#windows-prerequisites)). In PowerShell, use `$env:BUZZ_ACP_AGENT_COMMAND = "codex-acp"` and the equivalent `$env:CODEX_API_KEY` or `$env:OPENAI_API_KEY` assignment.

## Running with Claude Code

Expand Down