Codex (OpenAI) 配置教程

安装并配置 Codex CLI 工具，通过配置文件连接 CodyRouter 平台。

Codex 是支持 OpenAI API 兼容接口的 CLI 工具，使用配置文件的方式进行设置。本教程将引导你完成安装和配置。

开始前请先完成 Node.js 环境安装教程。

第一步：安装 Codex

npm install -g @openai/codex@latest

sudo npm install -g @openai/codex@latest

以上命令会从 npm 官方仓库下载并安装最新版本的 Codex 工具。

验证安装

codex --version

如果显示版本号，恭喜你！Codex 已经成功安装了。

第二步：创建配置文件

Codex 使用配置文件进行连接设置，需要创建 config.toml 和 auth.json 两个文件。

创建配置文件

选择你的系统，复制对应命令到 Terminal 回车。

Windows PowerShell

# 删除旧目录并创建新目录
if (Test-Path "$env:USERPROFILE\.codex") { Remove-Item -Recurse -Force "$env:USERPROFILE\.codex" }
mkdir "$env:USERPROFILE\.codex"

# 创建 config.toml
@"
model_provider = "codyrouter"
model = "gpt-5.3-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.codyrouter]
name = "codyrouter"
base_url = "https://api.codyrouter.com/"
wire_api = "responses"
requires_openai_auth = true
"@ | Out-File -FilePath "$env:USERPROFILE\.codex\config.toml" -Encoding utf8

# 创建 auth.json
@"
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
"@ | Out-File -FilePath "$env:USERPROFILE\.codex\auth.json" -Encoding utf8

macOS / Linux

# 删除旧目录并创建新目录
rm -rf ~/.codex && mkdir -p ~/.codex

# 创建 config.toml
cat > ~/.codex/config.toml << 'EOF'
model_provider = "codyrouter"
model = "gpt-5.3-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.codyrouter]
name = "codyrouter"
base_url = "https://api.codyrouter.com/"
wire_api = "responses"
requires_openai_auth = true
EOF

# 创建 auth.json
cat > ~/.codex/auth.json << 'EOF'
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
EOF

请将 YOUR_API_KEY 替换为在 控制台 页面中复制的 API Key。

第三步：开始使用

现在你可以开始使用 Codex 了：

codex

更多使用说明请参考 OpenAI 官方文档。