Codex

Codex CLI 支持通过 config.toml 添加自定义模型 Provider。GetRouter 推荐使用 OpenAI Responses 协议。

配置状态
  • 推荐协议: OpenAI Responses
  • 配置格式核对: 2026-07-15(OpenAI Codex 官方配置参考)
  • 运行验证: 待验证

适合什么场景

  • 在终端中分析和修改代码;
  • 执行测试、重构和仓库级任务;
  • 使用 GetRouter 的模型 ID 和独立额度管理 Codex 用量。

1. 安装 Codex CLI

npm install -g @openai/codex
codex --version

如果已安装,请先记录版本。Codex 的配置字段可能随版本演进。

2. 创建专用 API Key

API Keys 创建例如 codex-local 的 Key,并放入环境变量:

export GETROUTER_API_KEY="YOUR_API_KEY"

需要长期使用时,把变量写入系统安全凭据方案或 Shell 配置,并限制配置文件权限。

3. 配置 Provider

编辑 ~/.codex/config.toml

model = "MODEL_ID"
model_provider = "getrouter"

[model_providers.getrouter]
name = "GetRouter"
base_url = "https://getrouter.ai/v1"
env_key = "GETROUTER_API_KEY"
wire_api = "responses"

如果文件已有其他设置,只合并以上字段,不要覆盖审批、沙箱或 MCP 配置。

配置说明

字段作用
modelMODEL_IDGetRouter 模型 ID
model_providergetrouter选择自定义 Provider
base_urlhttps://getrouter.ai/v1Codex 会追加 /responses
env_keyGETROUTER_API_KEY从环境变量读取 Key
wire_apiresponses使用 Responses 协议

最终请求路径: POST https://getrouter.ai/v1/responses

4. 验证

在一个测试仓库中运行:

codex

先提交只读任务,例如“概括这个项目的目录结构,不修改文件”。确认成功后,再测试:

  • 流式输出;
  • 读取仓库上下文;
  • 工具调用;
  • 文件修改与命令执行;
  • 长任务中的重试和费用。

常见问题

现象处理
提示缺少环境变量从同一个终端执行 echo ${GETROUTER_API_KEY:+set} 后重启 Codex
请求发到 /chat/completions检查 wire_api = "responses" 和当前 Codex 版本
/v1/v1/responsesbase_url 被错误写成了重复路径
文本正常但工具失败更换支持 Tool Calling 的模型并核对 Responses 事件兼容性
修改不生效检查项目级配置是否覆盖 ~/.codex/config.toml

安全建议

Codex 可以执行命令和修改文件。首次连接新模型时,在测试仓库中使用保守审批设置,不要将 API Key 直接写入 config.toml