Codex CLI

官方主页：developers.openai.com/codex/cli
安装文档：developers.openai.com/codex/cli（Windows 见 Windows 指南）
配置参考：developers.openai.com/codex/config-reference

安装

Codex CLI 官方推荐使用独立安装脚本（独立二进制，无需 Node.js），支持 macOS、Linux 与 Windows。其余写法以官方安装文档为准。

独立安装脚本（推荐）

macOS / Linux：

curl -fsSL https://chatgpt.com/codex/install.sh | sh

Windows（PowerShell，原生运行）：

irm https://chatgpt.com/codex/install.ps1 | iex

Windows 也可在 WSL2 中按 macOS / Linux 方式安装，详见官方 Windows 指南。

npm 备选（需 Node.js 18+）

npm install -g @openai/codex

Homebrew 备选（macOS）

brew install --cask codex

安装完成后用 codex --version 确认。升级独立安装版只需重新运行一次安装脚本。

对接 TokenBay

对接机制

Codex CLI 默认连接 OpenAI 官方服务。要改走 TokenBay，需在用户级配置 ~/.codex/config.toml 中注册一个自定义 provider，包含下列属性：

base_url 指向 TokenBay 网关；
env_key 指定存放 API Key 的环境变量名——Codex 不在配置文件里明文存 Key，而是运行时去读这个环境变量。

Base URL 注意：Codex 在 responses 协议（唯一支持的 wire_api）下，会在 base_url 后追加 /responses 端点，因此 provider 的 base_url 必须写成 https://api.tokenbay.com/v1（带 /v1），而不是裸的 https://api.tokenbay.com，否则会 404。

配置层级：model_provider 与 model_providers 只能写在用户级 ~/.codex/config.toml；项目级 .codex/config.toml 会忽略这两个键。

1. 获取 API Key

控制台创建 API Key

2. 配置环境变量

Codex 通过 env_key 指定的变量名读取凭证，下面统一用 TOKENBAY_API_KEY：

变量	值
`TOKENBAY_API_KEY`	你的 TokenBay API Key（`sk-...`）

macOS / Linux（zsh 或 bash）

把下面这行追加到 ~/.zshrc 或 ~/.bashrc，然后执行 source ~/.zshrc 让其生效：

export TOKENBAY_API_KEY="sk-XXXXXXX"

Windows（PowerShell，写入用户级环境）

[Environment]::SetEnvironmentVariable('TOKENBAY_API_KEY','sk-XXXXXXX','User')

Windows（CMD）

setx TOKENBAY_API_KEY "sk-XXXXXXX"

PowerShell 与 CMD 的写法都是永久化用户环境变量，需要新开一个终端窗口才会读到。

3. 配置 $HOME/.codex/config.toml

文件不存在则先新建，然后追加以下内容：

model_provider = "tokenbay"
model = "gpt-5.3-codex"
model_reasoning_effort = "xhigh"
 
[model_providers.tokenbay]
name = "TokenBay"
base_url = "https://api.tokenbay.com/v1"
env_key = "TOKENBAY_API_KEY"

字段说明：

字段	含义
`model_provider`	激活的 provider 名，默认值 `openai`
`model`	默认使用的模型 ID
`model_reasoning_effort`	默认的推理强度（可选），可选值为 `minimal`、`low`、`medium`、`high`、`xhigh`
`name`	provider 的显示名称
`base_url`	TokenBay 的 OpenAI 兼容端点根（含 `/v1`）
`env_key`	存放 API Key 的环境变量名
`wire_api`	provider 使用的协议（可选），目前仅支持 `responses`，省略时默认也是 `responses`

4. 推荐模型

用途	模型 ID
编程与代码（推荐）	`gpt-5.3-codex`
通用旗舰 / 复杂推理	`gpt-5.5`
高性价比	`gpt-5.4-mini`

模型名格式：模型名称中版本号仅接受小数点形式（如 gpt-5.4），不要写成连字符形式（gpt-5-4）。

上表为示例，准确的 Model ID、模态与端点以模型清单为准；接入前请核对并确认所属分组已授权该模型。

5. 进阶配置

复杂推理或长上下文任务耗时较长，默认超时可能导致请求中断。可在 provider 表里加上重试与流空闲超时项：

model_provider = "tokenbay"
model = "gpt-5.3-codex"
model_reasoning_effort = "xhigh"
 
[model_providers.tokenbay]
name = "TokenBay"
base_url = "https://api.tokenbay.com/v1"
env_key = "TOKENBAY_API_KEY"
request_max_retries = 4
stream_max_retries = 5
stream_idle_timeout_ms = 600000

字段	含义
`request_max_retries`	请求失败时的最大重试次数，默认4次
`stream_max_retries`	流式响应中断时的最大重试次数，默认5次
`stream_idle_timeout_ms`	流式响应空闲超时上限（单位毫秒，默认为5分钟，上例改为了10分钟）

6. 验证接入

进入会话后执行 /status，确认走的是 TokenBay 而非官方：

/status

Model provider 应显示为 TokenBay - https://api.tokenbay.com/v1。