Codex CLI 全平台安装步骤
1. 支持平台
| 平台 | 推荐安装方式 | 备注 |
|---|---|---|
| macOS | 独立安装器 / Homebrew / npm | 推荐独立安装器或 Homebrew |
| Linux | 独立安装器 / npm | 推荐独立安装器 |
| Windows | PowerShell 独立安装器 / npm / WSL2 | 推荐原生 PowerShell;需要 Linux 工具链时用 WSL2 |
Codex CLI 可以在本地终端运行,能读取、修改并执行当前目录下的代码。(OpenAI开发者)
安装后可以vscode 使用 codex切换器 插件一键切换配置
Codex provider switcher for VS Code and Codex workflows.
2. macOS / Linux 安装
推荐方式:官方独立安装器
bash
curl -fsSL https://chatgpt.com/codex/install.sh | sh
安装完成后运行:
bash
codex
首次运行会进入登录流程,可以选择 ChatGPT 账号登录 或 API Key 登录 。(OpenAI开发者)
3. macOS / Linux 无交互安装
适合服务器、CI、批量安装脚本:
bash
curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_NON_INTERACTIVE=1 sh
CODEX_NON_INTERACTIVE=1 会跳过安装器提示,适合脚本化安装和升级。(OpenAI开发者)
4. Windows 安装
推荐方式:PowerShell 官方安装器
在 PowerShell 中运行:
powershell
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"
安装完成后运行:
powershell
codex
官方说明 Windows 可以原生运行 Codex,也可以通过 WSL2 运行;Windows 11 是推荐环境,较新的 Windows 10 属于尽力支持。(OpenAI开发者)
5. Windows 无交互安装
适合企业批量部署、脚本安装:
powershell
$env:CODEX_NON_INTERACTIVE=1; irm https://chatgpt.com/codex/install.ps1 | iex
6. Windows 使用 WSL2 安装
适合以下情况:
-
项目本身在 Linux 环境开发;
-
需要 Linux 原生工具链;
-
Windows 原生沙箱不可用;
-
仓库已经放在 WSL2 的 Linux 文件系统里。
先在管理员 PowerShell 或 Windows Terminal 中运行:
powershell
wsl --install
wsl
进入 WSL 后运行:
bash
curl -fsSL https://chatgpt.com/codex/install.sh | sh
codex
官方建议 WSL2 下把项目放在 Linux home 目录,例如 ~/code/my-app,不要长期放在 /mnt/c/...,这样 I/O 和权限问题更少。(OpenAI开发者)
7. npm 安装方式
适合已经安装 Node.js / npm 的开发者:
bash
npm install -g @openai/codex
然后运行:
bash
codex
官方 Quickstart 将 npm 作为可选安装方式之一。(OpenAI开发者)
8. Homebrew 安装方式
适合 macOS 用户:
bash
brew install --cask codex
然后运行:
bash
codex
官方 Quickstart 目前给出的 Homebrew 命令是 brew install --cask codex。(OpenAI开发者)
9. 升级 Codex CLI
macOS / Linux 独立安装器升级
重新运行安装器即可:
bash
curl -fsSL https://chatgpt.com/codex/install.sh | sh
官方说明独立安装器升级方式就是重新执行安装命令。(OpenAI开发者)
Windows 独立安装器升级
powershell
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"
npm 升级
bash
npm install -g @openai/codex@latest
Homebrew 升级
bash
brew upgrade --cask codex
10. 登录方式
Codex 支持两类登录:
| 登录方式 | 适合场景 |
|---|---|
| ChatGPT 账号登录 | 个人开发、团队订阅、使用 ChatGPT 订阅权益 |
| API Key 登录 | 自动化、CI/CD、按 API 用量计费 |
官方说明:CLI 和 IDE 扩展支持 ChatGPT 登录和 API Key 登录;Codex Cloud 需要 ChatGPT 登录。API Key 更适合程序化 CLI 工作流,例如 CI/CD。(OpenAI开发者)
运行:
bash
codex
然后按照终端提示登录即可。
11. 验证安装
安装完成后可以执行:
bash
codex --help
或:
bash
codex
进入项目目录后运行:
bash
cd your-project
codex
建议第一次使用前先提交 Git:
bash
git status
git add .
git commit -m "checkpoint before codex"
因为 Codex 可以修改代码,官方也建议在使用前后建立 Git checkpoint,方便回滚。(OpenAI开发者)
12. 常用环境变量
| 变量 | 用途 |
|---|---|
CODEX_NON_INTERACTIVE=1 |
跳过安装器交互提示,适合脚本安装 |
CODEX_INSTALL_DIR |
自定义 codex 命令安装目录 |
CODEX_HOME |
自定义 Codex 配置、认证、日志、会话等状态目录 |
CODEX_ACCESS_TOKEN |
用于可信自动化场景的 ChatGPT / Codex access token |
CODEX_API_KEY |
用于 codex exec 的单次非交互 API Key |
RUST_LOG=debug |
排查问题时打开更详细日志 |
这些变量来自官方 Codex 环境变量说明。(OpenAI开发者)
13. 推荐安装选择
| 用户类型 | 推荐方案 |
|---|---|
| 普通 macOS 用户 | brew install --cask codex 或官方 install.sh |
| 普通 Linux 用户 | 官方 install.sh |
| 普通 Windows 用户 | PowerShell 官方安装器 |
| Windows + Linux 开发流 | WSL2 + Linux 安装器 |
| Node.js 开发者 | npm install -g @openai/codex |
| 企业批量安装 | 独立安装器 + CODEX_NON_INTERACTIVE=1 |
| CI/CD 自动化 | API Key / access token + 非交互模式 |