🚀 OpenAI Codex 安装完整教程
📋 概述
Codex 是 OpenAI 开发的 AI 编程助手工具,能够帮助开发者自动生成代码、调试、优化代码等功能。本教程将详细介绍如何在您的系统上安装和配置 Codex CLI。
🔧 系统要求
必需组件
- Node.js: 版本 >= 22
- npm: 版本 >= 10
- 操作系统: macOS、Linux 或 Windows
推荐配置
- 内存: 至少 4GB RAM
- 网络: 稳定的互联网连接
- 存储: 至少 1GB 可用空间
🛠️ 安装步骤
第一步:安装 Node.js
方法一:使用 nvm(推荐)
# 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
# 重新加载 shell 配置
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
# 安装最新版 Node.js
nvm install 22
nvm use 22
方法二:使用官方安装包
macOS:
# 使用 Homebrew
brew install node
# 或下载官方安装包
# 访问 https://nodejs.org 下载 LTS 版本
Linux (Ubuntu/Debian):
# 更新包列表
sudo apt update
# 安装 Node.js 和 npm
sudo apt install nodejs npm
# 验证安装
node --version
npm --version
Windows:
# 使用 Chocolatey
choco install nodejs-lts
# 或下载官方安装包
# 访问 https://nodejs.org 下载 Windows 版本
第二步:验证 Node.js 和 npm 安装
# 检查版本
node --version
npm --version
# 预期输出:
# v22.x.x
# 10.x.x
📦 安装 Codex CLI
方法一:全局安装(推荐)
# 使用 npm 全局安装
npm install -g @openai/codex
# 国内环境使用镜像源
npm install -g @openai/codex --registry=https://registry.npmmirror.com
方法二:使用 yarn
# 安装 yarn
npm install -g yarn
# 使用 yarn 安装
yarn global add @openai/codex
方法三:源码安装(适用于开发者)
# 克隆仓库
git clone https://github.com/openai/codex-cli.git
cd codex-cli
# 安装依赖
npm install
# 链接到全局
npm link
🔐 配置和认证
第一步:获取 OpenAI API 密钥
- 访问 OpenAI Platform
- 登录您的账户
- 进入 API Keys 页面
- 创建新的 API 密钥
- 复制密钥并妥善保存
第二步:配置 Codex
创建配置目录
# macOS/Linux
mkdir -p ~/.config/codex
# Windows
mkdir -p %USERPROFILE%\.config\codex
创建配置文件
# 创建 config.toml
cat > ~/.config/codex/config.toml << EOF
[default]
api_key = "your_openai_api_key_here"
model = "gpt-4"
temperature = 0.7
max_tokens = 2000
[cli]
auto_save = true
verbose = false
EOF
创建认证文件
# 创建 auth.json
cat > ~/.config/codex/auth.json << EOF
{
"api_key": "your_openai_api_key_here",
"organization": "your_org_id_if_any"
}
EOF
第三步:环境变量配置(可选)
# 临时设置(当前会话有效)
export OPENAI_API_KEY="your_api_key_here"
# 永久设置(推荐)
echo 'export OPENAI_API_KEY="your_api_key_here"' >> ~/.bashrc
source ~/.bashrc
✅ 验证安装
检查版本
codex --version
运行测试
# 测试基本功能
codex --help
# 测试连接
codex test
🎯 基本使用方法
命令行界面
# 交互式模式
codex
# 直接生成代码
codex "创建一个 Python 函数来计算斐波那契数列"
# 分析代码
codex analyze --file example.py
# 优化代码
codex optimize --file example.py
常用命令
# 帮助
codex --help
# 查看配置
codex config list
# 更新配置
codex config set model gpt-4
# 清除缓存
codex cache clear
VS Code 集成
- 安装 Codex 扩展
- 在 VS Code 中按
Ctrl+Shift+P - 输入
Codex: Start - 开始使用 AI 编程助手
🐛 常见问题解决
问题 1:npm 安装失败
# 清理 npm 缓存
npm cache clean --force
# 使用不同 registry
npm config set registry https://registry.npmmirror.com
# 重新安装
npm install -g @openai/codex
问题 2:API 密钥错误
# 检查配置
codex config list
# 重新设置 API 密钥
codex config set api_key your_new_api_key
问题 3:网络连接问题
# 设置代理(如需要)
npm config set proxy http://proxy.company.com:8080
npm config set https-proxy http://proxy.company.com:8080
# 或使用镜像源
npm install -g @openai/codex --registry=https://registry.npmmirror.com
问题 4:权限问题
# macOS/Linux 解决方案
sudo chown -R $(whoami) ~/.npm
sudo chown -R $(whoami) /usr/local/lib/node_modules
# Windows 解决方案
# 以管理员身份运行命令提示符
📚 进阶配置
高级配置选项
# 创建高级配置文件
cat > ~/.config/codex/config.toml << EOF
[default]
api_key = "your_api_key"
model = "gpt-4"
temperature = 0.7
max_tokens = 2000
[cli]
auto_save = true
verbose = false
cache_dir = "~/.cache/codex"
[models]
default = "gpt-4"
fallback = "gpt-3.5-turbo"
[features]
code_completion = true
code_analysis = true
documentation = true
testing = true
EOF
自定义快捷键
# 在 .bashrc 或 .zshrc 中添加别名
alias codex-start='codex --mode interactive'
alias codex-gen='codex --mode generate'
alias codex-analyze='codex --mode analyze'
🔒 安全建议
- 保护 API 密钥:不要在代码中硬编码 API 密钥
- 定期更新:保持 Codex 和 Node.js 为最新版本
- 网络安全:使用 HTTPS 连接
- 访问控制:限制 Codex 对敏感代码的访问
📞 技术支持
官方资源
社区支持
🎉 总结
恭喜!您已成功安装并配置了 OpenAI Codex CLI。现在您可以开始使用这个强大的 AI 编程助手来:
- 自动生成代码
- 优化现有代码
- 调试和修复错误
- 生成文档
- 编写测试用例
开始使用 Codex,让 AI 助力您的编程工作吧!
本教程适用于 OpenAI Codex CLI 版本 1.0+ 最后更新:2026年5月21日
© 版权声明
文章版权归作者所有,未经允许请勿转载。
THE END
















暂无评论内容