梳理Codex从安装、环境变量设置到启动和故障排查的完整步骤以便快速解决配置问题


1. 前置准备

在开始之前,请确保系统中已经安装了 Node.jsnpm

1.1 验证安装

打开终端,运行以下命令来检查版本:

node --version
npm --version

1.2 升级 npm

建议将 npm 升级到最新版本,以避免潜在问题:

npm install -g npm@latest

2. 安装 Codex CLI

使用 npm 全局安装 Codex 命令行工具:

npm install -g @openai/codex

3. 配置环境变量

需要配置以下环境变量:

  • OPENAI_API_KEY

Windows 环境配置

方法一:永久设置(推荐)
  1. 右键点击 此电脑 → 属性
  2. 点击 高级系统设置
  3. 点击 环境变量
  4. 系统变量 区域点击 新建
  5. 添加API Key环境变量:
变量名: OPENAI_API_KEY
变量值: your_api_key_here

⚠️ 设置后需要 重启 PowerShell 或 CMD 窗口才能生效。

方法二:PowerShell 临时设置

仅对当前会话有效:

$env:OPENAI_API_KEY = "your_api_key_here"
方法三:PowerShell 永久设置(用户级)
[System.Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "your_api_key_here", [System.EnvironmentVariableTarget]::User)
验证 Windows 环境变量
echo $env:OPENAI_API_KEY

macOS 环境配置

方法一:Terminal 临时设置

仅对当前会话有效:

export OPENAI_API_KEY="your_api_key_here"
方法二:Terminal 永久设置(推荐)
  • zsh (macOS 默认 Shell)
echo 'export OPENAI_API_KEY="your_api_key_here"' >> ~/.zshrc
source ~/.zshrc
  • bash
echo 'export OPENAI_API_KEY="your_api_key_here"' >> ~/.bash_profile
source ~/.bash_profile
验证 macOS 环境变量
echo $OPENAI_API_KEY

4. 启动 Codex

  1. 在终端中输入启动命令:

    codex
    
  2. 启动后,程序会进入交互界面。

  3. 在出现的菜单中,选择 2. continue using API key

⚠️ 如果无法选择自定义 API Key,请尝试使用:

codex --config preferred_auth_method='apikey'
  1. 如果之前登录过 OpenAI 官方账户,请运行以下命令退出:
/logout

5. 故障排查

问题一:环境变量不生效?

macOS
  • 检查配置文件:确认修改的是正确的 Shell 配置文件(~/.zshrc~/.bash_profile
  • 重启终端:关闭并重新打开 Terminal
  • 验证变量:
    echo $OPENAI_API_KEY
    
Windows
  • 重启终端:永久环境变量设置后需重启 PowerShell 或 CMD
  • 重新登录:部分情况需注销并重新登录 Windows 系统
  • 验证变量:
    echo $env:OPENAI_API_KEY
    

问题二:解决 404 错误

  1. 找到 Codex 的配置文件:

    ~/.codex/config.toml
    
  2. 打开并添加以下配置:

    disable_response_storage = true
    
  3. 保存文件后,重新启动 Codex。


✅ 到这里,Codex安装流程就完成了。