Codex CLI 安装与设置
在终端里使用 Codex,完成代码阅读、修改和问题排查。选择操作系统后,本页其他系统标签会同步切换。
1. 安装 Codex CLI
- Windows
- Linux
- macOS
在 PowerShell 中选择一种方式安装 Codex CLI。
- curl
- npm
使用 curl 下载并运行官方 Windows 安装脚本,无需 Node.js。
$codexInstaller = curl.exe -fsSL https://chatgpt.com/codex/install.ps1
if ($LASTEXITCODE -eq 0) {
Invoke-Expression ($codexInstaller -join [Environment]::NewLine)
}
没有 curl?安装 curl
Windows 10 新版本和 Windows 11 通常已自带 curl,可以先检查:
curl.exe --version
如果找不到命令,从官网下载适合系统架构的压缩包,解压后将其中的 bin 目录添加到用户 Path 环境变量,再重新打开 PowerShell。
下载 curl for Windows ↗已有 Node.js 和 npm 时,直接运行:
npm.cmd install -g @openai/codex
没有 npm?安装 Node.js 与 npm
从 Node.js 官网选择 LTS 版本,下载 Windows 安装程序(.msi),按默认选项完成安装;npm 会一并安装。
安装 Node.js ↗重新打开 PowerShell,检查安装结果:
node --version
npm.cmd --version
安装完成后,重新打开 PowerShell,检查 Codex 版本:
cmd /c codex --version
在 WSL 内运行时,请使用 Linux 标签页,并在 WSL 内安装、配置和启动 Codex。
显示版本号表示安装完成。升级时使用原来的安装方式,避免多个版本混用。
先安装适合当前发行版的 Node.js LTS,再在终端中安装 Codex。
node --version
npm --version
npm install -g @openai/codex
codex --version
显示版本号表示安装完成。升级时使用原来的安装方式,避免多个版本混用。
在终端中使用 Homebrew 安装;如果尚未安装 Homebrew,也可使用下方 npm 方式。
brew install --cask codex
codex --version
显示版本号表示安装完成。升级时使用原来的安装方式,避免多个版本混用。
2. 配置 Supakook API
先备份已有配置,再合并下面的字段。保留原有 MCP、项目和权限设置,避免重复添加同名配置项。
- Windows
- Linux
- macOS
用户配置文件: %USERPROFILE%\.codex\config.toml
New-Item -ItemType Directory -Force "$env:USERPROFILE\.codex" | Out-Null
notepad "$env:USERPROFILE\.codex\config.toml"
用户配置文件: ~/.codex/config.toml
mkdir -p ~/.codex
touch ~/.codex/config.toml
nano ~/.codex/config.toml
用户配置文件: ~/.codex/config.toml
mkdir -p ~/.codex
touch ~/.codex/config.toml
open -e ~/.codex/config.toml
这是一份配置模板。 将 MODEL_ID_FROM_CONSOLE 替换为控制台支持的模型标识,将示例地址整段替换为交付的 Base URL。不要自行重复追加 /v1 或 /responses。
model_provider = "supakook"
model = "MODEL_ID_FROM_CONSOLE"
[model_providers.supakook]
name = "Supakook"
base_url = "https://api.example.com/v1"
wire_api = "responses"
env_key = "SUPAKOOK_API_KEY"
在当前终端设置自己的密钥,再进入项目启动。下面的密钥仅为占位符;环境变量只对当前终端及其子进程有效。
- Windows
- Linux
- macOS
$env:SUPAKOOK_API_KEY = "YOUR_API_KEY"
cd "C:\path\to\project"
cmd /c codex
export SUPAKOOK_API_KEY="YOUR_API_KEY"
cd /path/to/project
codex
export SUPAKOOK_API_KEY="YOUR_API_KEY"
cd /path/to/project
codex
如果设置了 CODEX_HOME,请使用它对应的配置目录。使用 WSL 时,Linux 配置目录与 Windows 用户目录不同。
3. 验证第一次连接
启动后查看当前模型与 provider 信息,确认使用了 supakook 和指定模型。再发送一个简单任务:
只阅读这个项目的 README,概括项目用途,先不要修改文件。
能收到回复只说明这次请求完成。再核对控制台是否出现相应调用记录,确认使用的是预期 API 服务,而非之前保留的其他配置。
常见问题
| 现象 | 检查方向 |
|---|---|
| 找不到 codex 命令 | 重新打开终端,检查安装位置与 PATH;Windows 可使用 cmd /c codex |
| Missing environment variable | 在启动 Codex 的同一终端设置 SUPAKOOK_API_KEY |
| 401 / 403 | 密钥是否有效,是否属于正确分组并有对应模型权限 |
| 404 / 不支持 Responses | Base URL 是否正确,服务是否支持 Responses,模型标识是否存在 |
| 配置没有生效 | 检查 CODEX_HOME、项目配置和启动参数是否覆盖用户配置 |
其他问题请查看 常见问题与排查。首次接入无需关闭沙箱或取消操作确认。
参考来源
安装方式参考 Codex CLI 官方文档,provider 与认证配置参考 官方配置说明和 认证说明。步骤组织参考 New API 安装指南与 Sub2API 客户端配置界面。