2026-05-19 文章

Codex CLI 安装与 API 配置全指南(支持第三方 API 网关)

详细介绍如何安装 Codex CLI 及其 VS Code 插件,并指导如何配置 auth.json 和 config.toml 以支持 OpenAI 官方及第三方 API 供应商。

Codex CLI 是一款强大的命令行工具,能够将大模型的编程能力直接集成到你的终端中。无论你是使用 OpenAI 官方接口,还是通过第三方 API 网关接入,正确的配置都是确保其稳定运行的关键。

🛠️ 安装前准备

在开始之前,请确保你的系统已安装以下环境:

  • Node.js: 22+ 版本
  • npm: 10+ 版本

📦 第一步:安装 Codex CLI

根据你的操作系统,选择相应的安装方式:

💻 Windows

  1. 环境安装:建议安装 Git Bash(提供类 Unix 终端体验)和 Node.js LTS
  2. 执行安装:在 CMD 或 PowerShell 中运行:
    npm install -g @openai/codex
    
  3. 验证安装
    codex --version
    

🍎 macOS

  1. 执行安装
    npm install -g @openai/codex
    
    注:如果遇到权限问题,请在命令前加上 sudo
  2. 验证安装
    codex --version
    
    可选:也可以使用 Homebrew 安装 $\rightarrow$ brew install codex

🐧 Linux

  1. 环境安装:根据发行版安装 Node.js 和 npm(例如 sudo apt install nodejs npm)。
  2. 执行安装
    sudo npm install -g @openai/codex
    
  3. 验证安装
    codex --version
    

⚙️ 第二步:配置 API 密钥与供应商

Codex CLI 的所有配置均存储在用户目录下的 .codex 隐藏文件夹中。

1. 目录定位

  • Windows: C:\Users\你的用户名\.codex (若不可见,请在资源管理器开启“显示隐藏项目”)
  • macOS/Linux: ~/.codex

如果文件夹不存在,请手动创建:

mkdir -p ~/.codex

2. 配置 auth.json (身份认证)

在该目录下创建 auth.json 文件,用于存储 API Key。 文件内容:

{
  "OPENAI_API_KEY": "你的实际-API-Key"
}

3. 配置 config.toml (模型与网关)

创建 config.toml 文件,定义模型供应商及请求路径。

配置模版:

model_provider = "供应商名称"
model = "具体模型名称"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.供应商名称]
name = "供应商名称"
base_url = "https://实际网关地址/v1"
wire_api = "responses"

⚠️ 重要提示:请确保 model_provider 的值与 [model_providers.xxx] 段落中的名称完全一致。

生效操作:修改配置后,请重启终端并重新启动 codex 以使配置生效。


🔌 第三步:集成 VS Code 插件

完成上述 .codex 文件夹配置后,你可以获得更直观的 UI 体验:

  1. 在 VS Code 扩展商店搜索并安装 Codex 插件。
  2. 安装完成后,插件将出现在侧边栏。
  3. 插件会自动读取 ~/.codex 中的配置,你现在可以直接在编辑器中调用 AI 能力。

💡 总结

通过 npm 安装 $\rightarrow$ 配置 .codex 目录 $\rightarrow$ 联动 VS Code 插件,你便拥有了一个高效的 AI 编程辅助环境。无论接口如何变更,只需修改 config.toml 即可快速切换供应商。