Skip to content

Codex

Codex CLI 可通过自定义模型提供商连接云枢 Responses API。配置前请先准备访问令牌和支持 Responses API 的模型 ID。

安装

安装 Node.js LTS,然后执行:

bash
npm install --global @openai/codex
codex --version

配置云枢提供商

打开用户级配置文件:

  • Windows:%USERPROFILE%\.codex\config.toml
  • macOS / Linux:~/.codex/config.toml

写入以下配置,并把 your-model-id 替换为控制台中的模型 ID:

toml
model_provider = "yunshu"
model = "your-model-id"

[model_providers.yunshu]
name = "Yunshu API"
base_url = "https://yunshuapi.org/v1"
wire_api = "responses"
env_key = "OPENAI_API_KEY"

配置位置

自定义提供商必须配置在用户级 ~/.codex/config.toml。项目中的 .codex/config.toml 不能覆盖 model_providermodel_providers 或提供商认证设置。

设置 API Key

Windows PowerShell

当前终端临时使用:

powershell
$env:OPENAI_API_KEY = "sk-your-token"
codex

保存为用户环境变量:

powershell
[Environment]::SetEnvironmentVariable(
  "OPENAI_API_KEY",
  "sk-your-token",
  "User"
)

macOS / Linux

当前终端临时使用:

bash
export OPENAI_API_KEY="sk-your-token"
codex

长期使用可将 export 行写入 ~/.zshrc~/.bashrc,然后重新打开终端。

验证

在一个测试项目中启动 Codex:

bash
codex

先让 Codex 执行只读任务,例如“说明这个项目的目录结构”。确认请求成功后,再根据需要授予文件写入或命令执行权限。

常见问题

提示找不到环境变量

确认变量名与配置中的 env_key = "OPENAI_API_KEY" 完全一致,并重启终端或 IDE。

提示模型不存在

model 改为云枢控制台当前开放、且支持 Responses API 的模型 ID。

CLI 能用,IDE 扩展不能用

Codex CLI 和 IDE 扩展共享用户级配置。完全退出 IDE 后,从已经设置环境变量的终端重新启动,或使用系统用户环境变量。

配置依据

本页自定义提供商写法遵循 OpenAI Codex 官方配置说明中的 model_providersbase_urlwire_apienv_key 选项。云枢域名和模型权限以云枢控制台为准。

云枢使用文档