mirror of
https://github.com/coder/coder.git
synced 2026-10-29 17:44:33 +08:00
Danny Kopping
7a94a683c4
*Disclaimer: implemented by a Coder Agent using Claude Opus 4.6* ## Summary Renames product references across documentation: | Old Name | New Name | |----------|----------| | AI Bridge | AI Gateway | | AI Bridge Proxy | AI Gateway Proxy | | Agent Boundaries | Agent Firewall | ## What changed - Prose text, headings, titles, and descriptions updated across all docs - Directories renamed: - `docs/ai-coder/ai-bridge/` → `docs/ai-coder/ai-gateway/` - `docs/ai-coder/ai-bridge/ai-bridge-proxy/` → `docs/ai-coder/ai-gateway/ai-gateway-proxy/` - `docs/ai-coder/agent-boundaries/` → `docs/ai-coder/agent-firewall/` - All internal markdown links updated to new paths - `manifest.json` route paths updated - Rename notice added to AI Gateway and Agent Firewall entrypoint pages ## Companion PR URL redirects (old paths → new paths): [coder/coder.com#700](https://github.com/coder/coder.com/pull/700) ## What is intentionally NOT changed - **Env vars**: `CODER_AIBRIDGE_*` - **CLI flags**: `--aibridge-*` - **API paths**: `/api/v2/aibridge/*` - **Config keys**: `aibridge:` YAML blocks - **Terraform variables**: `enable_aibridge`, `boundary_version`, `use_boundary_directly` - **Process names**: `aibridged`, `aibridgeproxyd` - **Prometheus metrics**: `coder_aibridged_*`, `coder_aibridgeproxyd_*` - **SDK types**: `codersdk.AIBridge*` - **GitHub URLs**: `github.com/coder/aibridge` - **Image paths**: `images/aibridge/` - **Auto-generated reference docs**: `docs/reference/cli/aibridge*.md`, `docs/reference/api/aibridge.md`, `docs/reference/api/schemas.md` - **Frontend code**: `site/src/` references (separate PR) Code-level renames (env vars, configs, frontend) are planned for a follow-up PR.
98 lines
2.9 KiB
Markdown
98 lines
2.9 KiB
Markdown
# Codex CLI
|
|
|
|
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 session 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-session-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_SESSION_TOKEN" }
|
|
```
|
|
|
|
Set both environment variables:
|
|
|
|
```bash
|
|
# Your personal OpenAI API key, forwarded to OpenAI.
|
|
export OPENAI_API_KEY="<your-openai-api-key>"
|
|
|
|
# Your Coder session token, used for authentication with AI Gateway.
|
|
export CODER_SESSION_TOKEN="<your-coder-session-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_SESSION_TOKEN" }
|
|
```
|
|
|
|
> [!NOTE]
|
|
> The `base_url` uses `/aibridge/chatgpt/v1` instead of `/aibridge/openai/v1` to route requests through the ChatGPT provider.
|
|
|
|
Set your Coder session token and ensure `OPENAI_API_KEY` is not set:
|
|
|
|
```bash
|
|
# Your Coder session token, used for authentication with AI Gateway.
|
|
export CODER_SESSION_TOKEN="<your-coder-session-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_aibridge = true
|
|
}
|
|
```
|
|
|
|
**References:** [Codex CLI Configuration](https://developers.openai.com/codex/config-advanced)
|