Skip to content

环境准备

根据 CSDN「Codex CLI 教程」专栏整理的要求矩阵:

依赖项 最低要求 推荐配置
操作系统 Windows 10/11、macOS 12+、主流 Linux 发行版 Windows 11(推荐 WSL2)、macOS 14+、Ubuntu 22.04+
Node.js v20.0.0+ v22.0.0+(LTS 长期支持版)
npm v10.0.0+ 最新稳定版

⚠️ Codex CLI 依赖 Node.js 22+。版本过低会直接安装失败或运行异常。

执行以下两条命令确认环境符合要求:

Terminal window
# 检查 Node.js 版本,需 v20.0.0 及以上
node --version
# 检查 npm 版本,需 v10.0.0 及以上
npm --version

适合需要在不同 Node 版本间切换的开发者:

Terminal window
# 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
# 安装 Node 22
nvm install 22
# 切换到 Node 22
nvm use 22
# 验证
node -v # 应输出 v22.x.x
Terminal window
brew install node@22
Terminal window
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get install -y nodejs

Node.js 官网 下载安装包,或用 winget:

Terminal window
winget install OpenJS.NodeJS.LTS

全局安装 npm 包时常见的 EACCES 权限错误,根因是默认全局目录需要 root 权限。不推荐用 sudo 安装 npm 包,推荐配置自定义全局目录:

Terminal window
# 创建自定义全局目录
mkdir ~/.npm-global
# 设置 npm 全局 prefix
npm config set prefix '~/.npm-global'
# 写入环境变量(bash 用户)
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
# zsh 用户
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc
source ~/.zshrc

配置完成后,后续 npm install -g 不再需要 sudo。

Terminal window
# 临时使用镜像
npm install -g @openai/codex --registry=https://registry.npmmirror.com
# 永久设置镜像
npm config set registry https://registry.npmmirror.com

Codex CLI 调用 OpenAI API 时需要网络可达。国内用户通常配置 HTTP 代理:

Terminal window
export HTTP_PROXY=http://127.0.0.1:7890
export HTTPS_PROXY=http://127.0.0.1:7890

可写入 ~/.zshrc~/.bashrc 持久化。验证代理生效:

Terminal window
curl -I https://api.openai.com

Codex 与 Git 深度集成(代码审查、worktree、PR 生成都依赖 Git),建议提前装好:

Terminal window
# macOS
brew install git
# Ubuntu/Debian
sudo apt-get install -y git
# Windows:从 git-scm.com 下载,或
winget install Git.Git
# 基础配置
git config --global user.name "你的名字"
git config --global user.email "你的邮箱"

Codex CLI 的某些功能依赖 Unix 环境,Windows 用户推荐使用 WSL2。在 PowerShell 管理员模式下运行:

Terminal window
# 安装 WSL2
wsl --install
# 重启后进入 WSL
wsl
  1. 确保 Windows 版本在 19041 或更高
  2. 启用“虚拟机平台”功能
  3. 下载并安装 WSL2 Linux 内核更新包
  4. 将 WSL2 设置为默认版本:wsl --set-default-version 2
  5. 从 Microsoft Store 安装 Ubuntu 发行版

进入 WSL 后,按上面 3.3 ~ 3.5 的 Linux 步骤安装 Node.js 和配置 npm 即可。

💡 CSDN 教程明确指出:Windows 用户若计划长期使用 Codex CLI,强烈推荐配置 WSL2 环境,兼容性和稳定性远优于原生 Windows 环境。

  • CSDN《Codex CLI 教程(一)安装指南》系统要求矩阵与 WSL 提示
  • FastGPTPlus《OpenAI Codex CLI 完整教程》macOS/Linux 安装步骤
  • 编程指北 csguide.cn 国内网络代理配置
  • 编程指北:Homebrew 已同步最新版 brew install codex