📘 Codex CLI 安装基础教程
Codex 是 OpenAI 推出的 AI 编程助手,支持在终端、IDE 或浏览器中使用,能帮你生成、修改和理解代码。 本教程将带你从零开始完成 Node.js 环境准备 → Codex CLI 安装 → 初始配置 的全流程,适配 macOS / Windows / Linux 三大平台,新手友好!
一、准备工作
✅ 1.1 账号与权限要求
- 你需要满足以下任一条件:
- 拥有 ChatGPT Plus / Pro / Business / Edu / Enterprise 订阅(用于 OAuth 登录);
- 或持有有效的 OpenAI API Key(可在 OpenAI 平台 创建)。
💡 提示:即使你没有 ChatGPT 订阅,只要有 API Key 也能使用 Codex CLI。
✅ 1.2 系统要求
- 支持 macOS、Windows、Linux 主流操作系统;
- 必须先安装 Node.js(含 npm) —— 这是 Codex CLI 的运行基础。
二、Node.js 安装(必做前置步骤)
⚠️ 重要:Codex CLI 基于 Node.js 开发,请务必先安装 LTS(长期支持)版本(推荐 v18+ 或 v20+)。
🪟 方式 1:Windows 系统
-
访问 Node.js 官网下载页;
-
下载 「Windows 安装程序 (.msi)」(64 位);
-
双击运行安装包:
- ✅ 务必勾选 “Add to PATH”(自动配置环境变量,关键!);
- 其余选项保持默认,点击 “Next” 直到 “Finish”;
-
验证安装:
node -v # 应输出类似 v20.10.0 npm -v # 应输出类似 10.2.3
🔒 若后续
npm install -g报权限错误,建议以 管理员身份运行终端。
🍏 方式 2:macOS 系统
方法 A:官方 .pkg 安装包(简单快捷)
-
从官网下载 「macOS Installer (.pkg)」;
-
双击安装,全程默认即可;
-
打开 Terminal,验证:
node -v && npm -v
方法 B:Homebrew 安装(推荐,便于管理)
-
若未安装 Homebrew,先执行:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -
安装 Node.js:
brew install node -
验证:
node -v && npm -v
💡 Homebrew 安装后,
npm全局包会自动加入 PATH,通常无需手动配置。
🐧 方式 3:Linux 系统(以 Ubuntu/Debian 为例)
基础安装(适合快速上手)
sudo apt update
sudo apt install -y nodejs npm
⚠️ 注意:Ubuntu 自带的
nodejs版本可能较旧(如 v12),建议升级。
推荐方式:使用 nvm(Node Version Manager)—— 更灵活
# 1. 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# 2. 重启终端,或加载配置
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
# 3. 安装最新 LTS 版本(如 v20.x)
nvm install --lts
nvm use --lts
# 4. 验证
node -v && npm -v
✅ 使用 nvm 可轻松切换 Node.js 版本,避免系统级冲突。
三、Codex CLI 安装
✅ 前提:已成功安装 Node.js 和 npm,并能运行
node -v。
📦 方式 1:npm 全局安装(跨平台通用,强烈推荐)
npm install -g @openai/codex
-
若遇权限错误:
-
Windows:以 管理员身份 打开终端;
-
macOS/Linux:加
sudo(但更推荐用 nvm 避免 sudo):
sudo npm install -g @openai/codex
-
-
验证安装:
codex -V # 应显示版本号,如 0.1.0
⚠️ 如果提示
command not found,说明 npm 全局路径未加入系统PATH。 解决方案:
- Windows:重装 Node.js 并确保勾选 “Add to PATH”;
- macOS/Linux(非 nvm):检查
echo $PATH是否包含$(npm config get prefix)/bin。
🍺 方式 2:Homebrew 安装(仅限 macOS / Linux)
⚠️ 注意:截至 2026 年 1 月,
@openai/codex尚未正式收录于 Homebrew 核心仓库。 若你看到brew install codex可用,可能是第三方 Tap。建议优先使用 npm 安装以确保官方版本。
❌ 因此,不推荐在正式教程中列出 Homebrew 安装方式,除非 OpenAI 官方提供 tap。
✅ 建议删除原教程中的 Homebrew 安装 Codex 部分,避免误导。
四、初始化与认证
-
在终端运行:
codex -
首次启动会引导你完成身份验证,二选一:
- OAuth 登录:打开浏览器,登录你的 ChatGPT 账号完成授权【此处需要科学上网:注意需要美国节点】;
- API Key 登录:粘贴你的 OpenAI API Key(格式:
sk-xxxx...)【需要有自己的或其他方式获取的正规账号,如果没有可以私信我,进行渠道推荐,尝鲜过程可能产生费用预计20元RMB左右】;如下图:
-
成功后,即可使用:
codex
4. 成功后,输入提示词:
帮我写一个科技感十足的科技公司企业网站,要求使用Vue3实现
5. 根据提示进行手动干预即可,最终给你肝出来一个科技感十足的企业网站
注意,由于网络问题,npm从官方拉取依赖会报错,如下图,选择2即可
5. 效果验证
肝完了,然后如下,咱们导入vs code看一下效果
进入项目目录执行如下命令
- 安装依赖
npm install
- 运行服务
npm run dev
- 浏览器预览效果
http://localhost:5173/
体验后,你会觉得很牛逼,更多请自行验证。
🔐 安全提示:API Key 会被本地加密存储(通常在
~/.config/openai/),不会明文保存。
五、安全与使用建议
-
代码安全第一:Codex 可能修改文件,建议操作前提交 Git:
git add . git commit -m "Before Codex: backup current state" -
查看帮助:
codex --help -
常见问题排查:
codex: command not found→ 检查 Node.js 安装及 PATH;- 权限错误 → 使用 nvm 或管理员权限;
- 网络超时 → 确保可访问
api.openai.com(国内用户可能需要代理)。
✅ 总结:三步走通 Codex
| 步骤 | 操作 | 验证命令 |
|---|---|---|
| 1️⃣ 安装 Node.js | 选 LTS 版,确保含 npm | node -v && npm -v |
| 2️⃣ 安装 Codex CLI | npm install -g @openai/codex | codex -v |
| 3️⃣ 首次运行认证 | codex → 登录或输入 API Key | 能正常生成代码即成功 |
🎉 恭喜!你现在可以随时随地用自然语言驱动编程了!