Skip to content

Codex CLI 配置

更新于 2026-09-20 · 页面与服务规则以当前控制台为准

桌面用户先看图文流程

使用 Windows 桌面软件与 CC Switch,直接看 Windows Codex 图文教程。本页针对终端 CLI 手工配置,避免把终端环境变量与桌面应用的环境混为一谈。

安装与版本检查

Codex 官方 CLI 文档选择当前支持的安装方式。使用 npm 时先安装受支持的 Node.js LTS,再运行:

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

不要把未经当前版本确认的诊断命令当成必须步骤。

先备份用户配置

用户配置通常位于 ~/.codex/config.toml;Windows 用户目录下为 .codex\config.toml。若设置了 CODEX_HOME,以实际目录为准。

修改前复制一份配置备份,合并下面需要的字段, 不要覆盖整个文件 。官方当前文档要求 Provider/鉴权放在用户级配置,而不是项目配置。

自定义 Provider 示例

将模型占位符替换为该密钥当前可用的完整模型 ID。本例使用独立环境变量保存 DragonAPI Key,并显式选择 Responses 协议。

toml
model = "YOUR_AVAILABLE_MODEL"
model_provider = "dragonapi"

[model_providers.dragonapi]
name = "DragonAPI"
base_url = "https://newapi.dragon3api.com/v1"
wire_api = "responses"
env_key = "DRAGONAPI_KEY"
requires_openai_auth = false

如果同名 Provider 已存在,应修改原配置块,避免重复 TOML 表定义。大陆线路可按 网络说明替换域名。

设置本次终端的 Key

macOS/Linux:

sh
export DRAGONAPI_KEY='YOUR_DRAGONAPI_KEY'
codex

Windows PowerShell:

powershell
$env:DRAGONAPI_KEY='YOUR_DRAGONAPI_KEY'
codex

占位符需要在本机换成自己的 Key,不要把真实 Key 发到聊天。以上只对当前终端及其启动的程序生效;从桌面图标启动的应用未必继承,应使用其支持的配置方式或 CC Switch。

env_key 和 requires_openai_auth

官方文档区分两种路径:

  • env_key:从指定环境变量读取供应商密钥,本页示例用这一种。
  • requires_openai_auth = true:使用 OpenAI 的登录/API Key 鉴权机制;启用时会忽略 env_key

旧 PDF 提醒过某些配置需 requires_openai_auth = true。它不是所有 401 的通用修复:使用 CC Switch 导入时先核对该版本生成的配置与鉴权方式,不要在 env_key 示例上直接改成 true。

验证与排错

启动后新建会话,发送短请求,再检查 使用日志中是否出现该模型的请求。一次成功的小请求可能产生少量费用。

  • 仍走官方地址:检查 model_provider 与对应配置块,确认编辑了实际使用的用户目录。
  • 环境变量未找到:在启动 Codex 的同一终端设置,或使用应用支持的凭据方式。
  • 模型无权限:检查完整模型 ID 与密钥分组。
  • 修改未生效:彻底退出后重开;不要先删除用户目录。

配置依据:官方自定义 Provider官方鉴权说明。DragonAPI 的地址与模型权限以本站配置为准。

模型、价格与服务规则以当前控制台为准。