https://api.xrouter.dev/v1,使用 XRouter API Key 调用可用模型。
准备工作
在开始之前,请确认:- 已安装 Node.js,建议使用最新 LTS 版本。
- 已在 XRouter 控制台创建 API Key,格式通常为
sk-...。 - 已确认目标模型在 XRouter 控制台中可用。
第一步:安装 Codex CLI
- npm
- Homebrew
Terminal
sudo 或切换 Node 版本管理器。Terminal
第二步:配置 XRouter API
Codex CLI 通过~/.codex/ 目录下的文件管理认证与模型供应商。按下面步骤新增一个 XRouter 自定义供应商。
2.1 找到配置目录
| 系统 | 配置目录 |
|---|---|
| macOS / Linux | ~/.codex/ |
| Windows | C:\Users\your-name\.codex\ |
codex,再按 Ctrl + C 退出,Codex 会生成配置目录。
2.2 配置 API Key
在配置目录下创建或编辑auth.json,写入 XRouter API Key:
~/.codex/auth.json
| 字段 | 说明 |
|---|---|
OPENAI_API_KEY | XRouter API Key,完整保留 sk- 前缀 |
2.3 配置模型供应商
在配置目录下创建或编辑config.toml,添加 XRouter 供应商:
~/.codex/config.toml
| 字段 | 说明 |
|---|---|
model | 默认模型 ID,可从 XRouter 模型页复制 |
model_provider | 默认供应商 ID,需要与 [model_providers.xrouter] 一致 |
name | Provider 显示名称 |
base_url | XRouter 的 OpenAI 兼容地址,固定为 https://api.xrouter.dev/v1 |
wire_api | Codex 通信协议,使用 responses |
requires_openai_auth | 设为 true,让 Codex 使用 auth.json 中的 OPENAI_API_KEY |
第三步:开始使用
验证配置
在任意项目目录运行:Terminal
交互模式
直接运行codex 进入交互界面:
Terminal
Prompt
审批模式
首次运行时,Codex 会让你选择操作审批级别。| 模式 | 说明 |
|---|---|
| 只读 | 仅允许读取文件,修改和命令需要确认 |
| 自动 | 可在工作目录内读写文件、运行命令,适合日常开发 |
| 完全访问 | 无需确认即可执行更多操作,请谨慎使用 |
/approvals 可以调整审批模式。
切换模型
在交互界面中输入/model 切换模型,或修改 config.toml 中的 model 字段后重启 Codex。
也可以在启动时临时指定模型:
Terminal
支持的模型
在 Codex CLI 中,建议优先选择 XRouter 控制台中可用的 Codex 或 GPT 系列编码模型。| 模型 ID | 特点 | 推荐场景 |
|---|---|---|
gpt-5.4 | 旗舰模型,综合能力强 | 复杂编码、架构设计 |
gpt-5.4-mini | 轻量、响应快 | 日常编码、快速迭代 |
gpt-5.3-codex | 面向 Codex 场景优化 | 智能体式编码任务 |
gpt-5.2 | 稳定均衡 | 常规编码任务 |
具体可用模型以 XRouter 控制台模型页为准。如果控制台中有更新的 Codex 模型,可以直接替换
config.toml 中的 model。使用环境变量认证
如果你不想使用auth.json,也可以通过环境变量传入密钥。把供应商配置改成:
~/.codex/config.toml
Terminal
常用命令
| 命令 | 说明 |
|---|---|
codex | 进入交互式界面 |
codex "任务描述" | 带初始指令启动 |
codex exec "任务描述" | 非交互模式,执行后退出 |
codex --model gpt-5.4 | 指定模型启动 |
codex --version | 查看版本号 |
/model | 在交互界面中切换模型 |
/approvals | 在交互界面中调整审批模式 |
Ctrl + C | 退出交互界面 |
常见问题
启动后弹出 ChatGPT 登录界面
启动后弹出 ChatGPT 登录界面
这通常说明 XRouter 自定义供应商配置没有生效。确认
config.toml 和 auth.json 位于 ~/.codex/,model_provider 为 xrouter,且 auth.json 是合法 JSON。出现 401 或 403 错误
出现 401 或 403 错误
401 通常表示 API Key 缺失或无效;403 通常表示权限不足、密钥停用或额度问题。请确认 auth.json 中的密钥完整,且 XRouter 控制台中密钥状态正常。提示连接失败
提示连接失败
确认
base_url 是 https://api.xrouter.dev/v1。如果你使用代理或公司网络,请确认该网络允许访问 api.xrouter.dev。提示 wire_api = "chat" 不再支持
提示 wire_api = "chat" 不再支持
新版 Codex CLI 使用 Responses API。请把
wire_api 设置为 responses,保存后重启 Codex。如何查看用量
如何查看用量
登录 XRouter 控制台查看 API 调用记录、Token 消耗和余额变化。