mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Ben Potter
cc001ccaf0
The Claude Code and Codex CLI registry modules expose the variable as `enable_ai_gateway`, not `enable_aibridge`. Templates using the docs as written fail Terraform init with `An argument named "enable_aibridge" is not expected here.` Verified in [`registry/coder/modules/claude-code/main.tf`](https://github.com/coder/registry/blob/main/registry/coder/modules/claude-code/main.tf) and [`registry/coder-labs/modules/codex/main.tf`](https://github.com/coder/registry/blob/main/registry/coder-labs/modules/codex/main.tf), where the variable is declared as `enable_ai_gateway` and gates the `ANTHROPIC_BASE_URL` / `ANTHROPIC_AUTH_TOKEN` injection. _Generated with the help of Coder Agents._
103 lines
3.0 KiB
Markdown
103 lines
3.0 KiB
Markdown
# Codex CLI
|
|
|
|
> [!NOTE]
|
|
> AI Gateway requires the [AI Governance Add-On](../../ai-governance.md).
|
|
> As of Coder v2.32, deployments without the add-on will not be able to
|
|
> access AI Gateway.
|
|
|
|
Codex CLI can be configured to use AI Gateway by setting up a custom model provider.
|
|
|
|
## Centralized API Key
|
|
|
|
To configure Codex CLI to use AI Gateway, set the following configuration options in your Codex configuration file (e.g., `~/.codex/config.toml`):
|
|
|
|
```toml
|
|
model_provider = "aibridge"
|
|
|
|
[model_providers.aibridge]
|
|
name = "AI Bridge"
|
|
base_url = "<your-deployment-url>/api/v2/aibridge/openai/v1"
|
|
env_key = "OPENAI_API_KEY"
|
|
wire_api = "responses"
|
|
```
|
|
|
|
To authenticate with AI Gateway, get your **[Coder API token](../../../admin/users/sessions-tokens.md#generate-a-long-lived-api-token-on-behalf-of-yourself)** and set it in your environment:
|
|
|
|
```bash
|
|
export OPENAI_API_KEY="<your-coder-api-token>"
|
|
```
|
|
|
|
Run Codex as usual. It will automatically use the `aibridge` model provider from your configuration.
|
|
|
|
## BYOK (Personal API Key)
|
|
|
|
Add the following to your Codex configuration file (e.g., `~/.codex/config.toml`):
|
|
|
|
```toml
|
|
model_provider = "aibridge"
|
|
|
|
[model_providers.aibridge]
|
|
name = "AI Bridge"
|
|
base_url = "<your-deployment-url>/api/v2/aibridge/openai/v1"
|
|
wire_api = "responses"
|
|
requires_openai_auth = true
|
|
env_http_headers = { "X-Coder-AI-Governance-Token" = "CODER_API_TOKEN" }
|
|
```
|
|
|
|
Set both environment variables:
|
|
|
|
```bash
|
|
# Your personal OpenAI API key, forwarded to OpenAI.
|
|
export OPENAI_API_KEY="<your-openai-api-key>"
|
|
|
|
# Your Coder API token, used for authentication with AI Gateway.
|
|
export CODER_API_TOKEN="<your-coder-api-token>"
|
|
```
|
|
|
|
## BYOK (ChatGPT Subscription)
|
|
|
|
Add the following to your Codex configuration file (e.g., `~/.codex/config.toml`):
|
|
|
|
```toml
|
|
model_provider = "aibridge"
|
|
|
|
[model_providers.aibridge]
|
|
name = "AI Bridge"
|
|
base_url = "<your-deployment-url>/api/v2/aibridge/chatgpt/v1"
|
|
wire_api = "responses"
|
|
requires_openai_auth = true
|
|
env_http_headers = { "X-Coder-AI-Governance-Token" = "CODER_API_TOKEN" }
|
|
```
|
|
|
|
> [!NOTE]
|
|
> The `base_url` uses `/aibridge/chatgpt/v1` instead of `/aibridge/openai/v1` to route requests through the ChatGPT provider.
|
|
|
|
Set your Coder API token and ensure `OPENAI_API_KEY` is not set:
|
|
|
|
```bash
|
|
# Your Coder API token, used for authentication with AI Gateway.
|
|
export CODER_API_TOKEN="<your-coder-api-token>"
|
|
|
|
# Ensure no OpenAI API key is set so Codex uses ChatGPT login instead.
|
|
unset OPENAI_API_KEY
|
|
```
|
|
|
|
When you run Codex, it will prompt you to log in with your ChatGPT account.
|
|
|
|
## Pre-configuring in Templates
|
|
|
|
If configuring within a Coder workspace, you can use the
|
|
[Codex CLI](https://registry.coder.com/modules/coder-labs/codex) module:
|
|
|
|
```tf
|
|
module "codex" {
|
|
source = "registry.coder.com/coder-labs/codex/coder"
|
|
version = "~> 4.1"
|
|
agent_id = coder_agent.main.id
|
|
workdir = "/path/to/project" # Set to your project directory
|
|
enable_ai_gateway = true
|
|
}
|
|
```
|
|
|
|
**References:** [Codex CLI Configuration](https://developers.openai.com/codex/config-advanced)
|