配置 Codex CLI 连接 CodexCN API 服务,国内直连,开箱即用。
Codex CLI 需要 Node.js v18 或更高版本。
方法一:使用 Homebrew(推荐)
# 更新 Homebrew
brew update
# 安装 Node.js
brew install node
方法二:官网下载
.pkg 文件,按安装向导完成方法一:官网下载(推荐)
.msi 文件,按向导安装(保持默认设置)方法二:使用包管理器
# 使用 Chocolatey
choco install nodejs
# 或使用 Scoop
scoop install nodejs
建议使用 PowerShell 而非 CMD,以获得更好的体验。
方法一:使用官方仓库(推荐)
# 添加 NodeSource 仓库
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
# 安装 Node.js
sudo apt-get install -y nodejs
方法二:使用系统包管理器
# Ubuntu/Debian
sudo apt update && sudo apt install nodejs npm
# CentOS/RHEL/Fedora
sudo dnf install nodejs npm
安装完成后验证:
node --version
npm --version
以管理员身份运行 PowerShell,执行:
npm i -g @openai/codex --registry=https://registry.npmmirror.com
验证安装:
codex --version
需要创建两个配置文件:config.toml 和 auth.json。
配置文件位于 ~/.codex/ 目录(不存在则创建)。
配置文件位于 C:\Users\你的用户名\.codex\ 目录(不存在则创建)。
创建 config.toml 文件:
model_provider = "codexcn"
model = "gpt-5.5"
model_reasoning_effort = "high"
network_access = "enabled"
disable_response_storage = true
windows_wsl_setup_acknowledged = true
model_verbosity = "high"
[model_providers.codexcn]
name = "codexcn"
base_url = "https://api2.codexcn.com/v1"
wire_api = "responses"
requires_openai_auth = true
[windows]
sandbox = "elevated"
model_provider = "codexcn"
model = "gpt-5.5"
model_reasoning_effort = "high"
network_access = "enabled"
disable_response_storage = true
windows_wsl_setup_acknowledged = true
model_verbosity = "high"
[model_providers.codexcn]
name = "codexcn"
base_url = "https://api2.codexcn.com/v1"
wire_api = "responses"
requires_openai_auth = true
[windows]
sandbox = "elevated"
创建 auth.json 文件:
{
"OPENAI_API_KEY": "your-api-key-here"
}
{
"OPENAI_API_KEY": "your-api-key-here"
}
将 your-api-key-here 替换为您购买的 API Key。如果还没有 Key,请先前往 定价页 购买。
此方式通过 auth.json 文件存储 API 密钥,config.toml 中无需配置 env_key 字段。
如果你使用 VS Code,可以安装 Codex 扩展获得更好的 IDE 集成体验。
config.toml 和 auth.jsonCODEX_API_KEY 为你的 API Keyenv_key 只能填写环境变量名称(如 CODEX_API_KEY),不能直接填写密钥值,否则会报错。
在项目目录下运行:
cd /path/to/your/project
codex
cd C:\path\to\your\project
codex
首次启动时,Codex 会进行初始化配置。如果连接正常,你将看到交互界面。
1. 命令未找到
# 检查 npm 全局安装路径
npm config get prefix
# 如果路径不在 PATH 中,添加到 ~/.zshrc
echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
C:\Users\你的用户名\AppData\Roaming\npm)已添加到系统 PATH# 检查 npm 全局安装路径
npm config get prefix
# 如果路径不在 PATH 中,添加到 ~/.bashrc
echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
2. API 连接失败
# 测试网络连接
curl -I https://api2.codexcn.com
# 检查配置文件是否正确
cat ~/.codex/config.toml
cat ~/.codex/auth.json
# 测试网络连接
Test-NetConnection -ComputerName api2.codexcn.com -Port 443
# 检查配置文件
Get-Content $HOME\.codex\config.toml
Get-Content $HOME\.codex\auth.json
3. 更新 Codex CLI
npm i -g @openai/codex --registry=https://registry.npmmirror.com