快速开始

Codex CLI 配置教程

安装并配置 Codex CLI，通过 config.toml 和 auth.json 把请求接到甜酒。

这篇文档和 `/dashboard/keys` 里的“使用密钥”示例使用同一套配置内容，避免再出现 docs 和用户中心各写一套。

第一步：安装 Codex CLI

Codex CLI 通过 npm 分发。先确认 Node.js 环境已经准备好，再安装最新版本。

npm install -g @openai/codex@latest

codex --version

第二步：准备 API Key 和配置目录

先在甜酒 `/dashboard/keys` 中选择一条可用于 Codex CLI 的 Key，再在本地准备 `.codex` 配置目录。文档里的示例使用占位值；你实际填写时，把 `YOUR_TIANJIU_API_KEY` 替换成自己的 Key。

Base URL 使用 `https://api.tianjiu.ai`。
如果某条 Key 的“使用密钥”弹窗里能看到 `Codex CLI` 标签，说明这条 Key 可以直接按下面方式接入。
配置目录默认是 `~/.codex` 或 `%userprofile%\.codex`。

if (Test-Path "$env:USERPROFILE\.codex") { Remove-Item -Recurse -Force "$env:USERPROFILE\.codex" }
New-Item -ItemType Directory -Path "$env:USERPROFILE\.codex"

第三步：写入标准 Codex 配置

把下面两个文件写入 Codex CLI 配置目录后，再重新打开终端运行 Codex。

先写入 `~/.codex/config.toml` 或 `%userprofile%\.codex\config.toml`。

model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true
model_context_window = 400000
model_auto_compact_token_limit = 300000

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://api.tianjiu.ai"
wire_api = "responses"
requires_openai_auth = true

请确保以下内容位于 config.toml 文件的开头部分。如果当前目录已经有 config.toml，请把下面内容放到文件开头，再补上 auth.json。

接着写入 `~/.codex/auth.json` 或 `%userprofile%\.codex\auth.json`。

{
  "OPENAI_API_KEY": "YOUR_TIANJIU_API_KEY"
}

第四步：需要 WebSocket 时替换 config.toml

这是带 Responses WebSocket v2 的 Codex CLI 配置，适合明确要走 WebSocket 模式时使用。

model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true
model_context_window = 400000
model_auto_compact_token_limit = 300000

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://api.tianjiu.ai"
wire_api = "responses"
supports_websockets = true
requires_openai_auth = true

[features]
responses_websockets_v2 = true

如果当前账号或网关没有开启 WebSocket 能力，优先先用普通 Codex CLI 配置。 auth.json 和上一步保持一致，不需要额外修改。

第五步：开始使用

配置写好后，先直接启动 Codex，跑一个简单任务确认会话、模型和错误回传都正常。

codex

如果提示鉴权失败，先检查 `auth.json` 是否写在正确目录。
如果提示模型不可用，优先确认当前 Key 所属分组是否支持 `Codex CLI` 对应模型。
如果需要 WebSocket 版本，优先确认当前账号或网关已经开启相关能力。