Codex CLI 使用指南

配置 Codex CLI 连接 CodexCN API 服务,国内直连,开箱即用。

1 安装 Node.js

Codex CLI 需要 Node.js v18 或更高版本。

安装完成后验证:

bash
node --version
npm --version
2 安装 Codex CLI
bash
npm i -g @openai/codex --registry=https://registry.npmmirror.com

验证安装:

bash
codex --version
3 连接 CodexCN API 服务

需要创建两个配置文件:config.tomlauth.json

创建 config.toml 文件:

创建 auth.json 文件:

your-api-key-here 替换为您购买的 API Key。如果还没有 Key,请先前往 定价页 购买。

此方式通过 auth.json 文件存储 API 密钥,config.toml 中无需配置 env_key 字段。

4 VS Code 扩展配置(可选)

如果你使用 VS Code,可以安装 Codex 扩展获得更好的 IDE 集成体验。

  • 在 VS Code 扩展商店搜索并安装 Codex – OpenAI's coding agent
  • 确保已按照上述步骤配置好 config.tomlauth.json
  • 设置环境变量 CODEX_API_KEY 为你的 API Key

env_key 只能填写环境变量名称(如 CODEX_API_KEY),不能直接填写密钥值,否则会报错。

5 启动 Codex

在项目目录下运行:

首次启动时,Codex 会进行初始化配置。如果连接正常,你将看到交互界面。

6 常见问题

1. 命令未找到

2. API 连接失败

3. 更新 Codex CLI

bash
npm i -g @openai/codex --registry=https://registry.npmmirror.com