Skip to content

Codex 接入

推荐配置方式

  1. 手动编辑配置文件(推荐):直接写入 ~/.codex/config.toml,见"手动配置参考"章节
  2. 环境变量:通过 export OPENAI_API_KEY=... 等方式配置,见"API Key"章节
  3. cc-switch 工具(备选):https://github.com/farion1231/cc-switch/releases,本质上也是修改上述配置项

安装前准备

Codex CLI 官方安装命令是通过 npm 全局安装,因此需要先准备好:

  • Node.js
  • npm(安装 Node.js 后通常会一起提供)

安装方式建议直接走 Node.js 官方下载页:https://nodejs.org/en/download

  • macOS / Windows:进入上面的官方页面,下载并安装 LTS 版本
  • Linux:在同一页面按你的发行版选择官方提供的安装方式或二进制包

如果你在 macOS 上已经安装了 Homebrew,也可以直接执行:

bash
brew install node

这会同时安装 Node.jsnpm

安装完成后,npm 通常会随 Node.js 一起可用。然后确认命令可用:

bash
node -v
npm -v

确认 npm 已可用后,再执行下面的安装命令。

安装

bash
npm i -g @openai/codex

API Key

如果你使用 API Key 模式,Codex 本地通常会在 ~/.codex/auth.json 保存鉴权信息。

如果你只是检查本地配置,可参考:

{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "codex_your_api_key"
}

这里的 OPENAI_API_KEY 就是你的 codex_...sk-... 等 Key。auth.json 一般不需要手动编辑,确认它已经以 apikey 模式保存即可。

如果你只是临时在当前 shell 会话里测试,也可以直接导出:

bash
export OPENAI_API_KEY="codex_your_api_key"

手动配置参考

可参考 ~/.codex/config.toml

model_provider = "custom"
model = "gpt-5.4"
disable_response_storage = true
model_reasoning_effort = "high"

[model_providers]
[model_providers.custom]
name = "custom"
base_url = "https://api.gemiaude.com/v1"
requires_openai_auth = true
wire_api = "responses"

[notice.model_migrations]
"gpt-5.2-codex" = "gpt-5.4"

这里的 base_url 应填写像 https://api.gemiaude.com/v1 这样的服务根路径,而不是 /v1/responses 的完整接口地址。

这套配置使用的是 Codex 的 API Key 鉴权模式:模型提供方为 custom,请求走 responses 协议,API Key 由 ~/.codex/auth.json 或当前 shell 里的 OPENAI_API_KEY 提供。

ChatGPT 账号登录 + 第三方 Provider(支持远程控制)

如果你希望在 Codex App 内保留 ChatGPT 账号登录状态,同时让 API 请求走第三方 Provider,可以使用这套配置。

这种方式的核心优势:Codex App 保持 ChatGPT 会话,可通过官方远程控制功能操控终端和设备(例如在手机端 ChatGPT App 里远程执行 Codex CLI 的任务),而模型调用实际走你配置的第三方接口。

auth.json

~/.codex/auth.json 改为 chatgpt 鉴权模式,并将 OPENAI_API_KEY 置为 null

{
  "auth_mode": "chatgpt",
  "OPENAI_API_KEY": null
}

config.toml

~/.codex/config.toml 中,通过 experimental_bearer_token 直接写入第三方 Provider 的 API Key,而不依赖 auth.json 里的 Key:

model_provider = "custom"
model = "gpt-5.4"
disable_response_storage = true
model_reasoning_effort = "high"

[model_providers]
[model_providers.custom]
name = "custom"
base_url = "https://api.gemiaude.com/v1"
experimental_bearer_token = "codex_your_api_key"
requires_openai_auth = true
wire_api = "responses"

[notice.model_migrations]
"gpt-5.2-codex" = "gpt-5.4"

base_url 填写像 https://api.gemiaude.com/v1 这样的服务根路径。model_provider 名称(custom)与标准配置保持一致,不需要调整。

与 API Key 模式的核心差异

配置项API Key 模式ChatGPT 账号模式
auth.jsonauth_mode"apikey""chatgpt"
auth.jsonOPENAI_API_KEY你的 Keynull
config.tomlexperimental_bearer_token无此字段你的 Key

配置步骤

  1. 启动 codex,按提示完成 ChatGPT 账号登录(auth_mode 此时为 chatgpt)。
  2. ~/.codex/auth.json 中的 OPENAI_API_KEY 改为 null(保留 auth_mode: "chatgpt")。
  3. ~/.codex/config.toml[model_providers.custom] 块里加入 experimental_bearer_token = "codex_your_api_key"
  4. 重启 codex,验证会话正常,模型解析到 gpt-5.4

验证

bash
codex

如果你已经能在会话里正常发起提问,并且模型解析到 gpt-5.4,说明接入成功。

VS Code 扩展

截至 2026-03-31,OpenAI 官方已经提供 Codex 的 VS Code IDE extension,并说明它兼容大多数 VS Code 分支。

如果你想在 VS Code 里使用 Codex:

  1. 在 VS Code 扩展市场搜索 Codex 并安装官方扩展。
  2. 打开 VS Code 的设置,搜索 Codex 可看到扩展自己的 UI 设置项。
  3. 真正影响模型、审批模式、sandbox 等行为的,仍然是共享的 ~/.codex/config.toml

对当前网关来说,VS Code 扩展不需要单独再写一套专用配置;沿用上面这份 ~/.codex/config.toml 和 API Key 配置即可。打开扩展侧边栏后能正常开始会话,说明这套共享配置已经生效。

OpenAI-compatible gateway integration docs