OpenAI Codex 设置

配置 Codex CLI 使用 AIDESK API。

Codex CLI 是 OpenAI 的命令行工具，专为代码相关的终端任务设计。它强调工程就绪的输出，提供更清晰、可操作的代码更改。配置使用 AIDESK 后，即可通过经济高效的端点访问多种 AI 模型。

前置条件

  • 一个 AIDESK 账户和 API Key
  • Node.js v20 或更高版本及 npm
前往创建 API Key

安装

确认 Node.js 和 npm 已安装：

node -v && npm -v

Node.js 需要 v20 或更高版本。如果未安装，请前往 nodejs.org 下载。

使用 npm 全局安装 Codex CLI：

npm install -g @openai/codex

验证安装：

codex --version

配置

Codex CLI 使用 config.toml 文件进行配置。配置目录位置：

  • Windows：%userprofile%\.codex
  • macOS/Linux：~/.codex

进入配置目录并创建或编辑 config.toml：

macOS/Linux：

mkdir -p ~/.codex
nano ~/.codex/config.toml

Windows PowerShell：

mkdir $env:USERPROFILE\.codex -Force
notepad $env:USERPROFILE\.codex\config.toml

添加以下配置内容：

model = "gpt-5.4"
model_reasoning_effort = "medium"
model_provider = "aidesk"

[model_providers.aidesk]
name = "AIDESK API"
base_url = "https://api.aideskapp.com/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"

model 可替换为 AIDESK 支持的任意模型，如 gpt-4.1、o4-mini、claude-sonnet-4-6 等。查看完整模型列表 →

wire_api = "responses" 表示使用 OpenAI Responses API 格式（非 Chat Completions），AIDESK 已支持该格式。

env_key 指定 Codex CLI 读取的环境变量名称，下一步将设置此变量。

以下命令会自动创建配置目录和文件，默认使用 gpt-5.4 模型。如需更换模型，编辑生成的 config.toml 即可。

macOS/Linux：

mkdir -p ~/.codex && cat > ~/.codex/config.toml << 'EOF'
model = "gpt-5.4"
model_reasoning_effort = "medium"
model_provider = "aidesk"

[model_providers.aidesk]
name = "AIDESK API"
base_url = "https://api.aideskapp.com/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"
EOF

Windows PowerShell：

$configPath = "$env:USERPROFILE\.codex"
New-Item -ItemType Directory -Force -Path $configPath | Out-Null
@"
model = "gpt-5.4"
model_reasoning_effort = "medium"
model_provider = "aidesk"

[model_providers.aidesk]
name = "AIDESK API"
base_url = "https://api.aideskapp.com/v1"
env_key = "OPENAI_API_KEY"
wire_api = "responses"
"@ | Out-File -FilePath "$configPath\config.toml" -Encoding utf8

设置 API 密钥

注意：尽管变量名为 OPENAI_API_KEY，请使用您的 AIDESK API 密钥。Codex CLI 使用此标准变量名保持兼容性。

macOS/Linux：

export OPENAI_API_KEY="sk-aidesk-YOUR_KEY"

Windows PowerShell：

$env:OPENAI_API_KEY="sk-aidesk-YOUR_KEY"

Windows 命令提示符：

set OPENAI_API_KEY=sk-aidesk-YOUR_KEY

macOS/Linux (Zsh) — 添加到 ~/.zshrc：

export OPENAI_API_KEY="sk-aidesk-YOUR_KEY"

应用：source ~/.zshrc

macOS/Linux (Bash) — 添加到 ~/.bashrc：

export OPENAI_API_KEY="sk-aidesk-YOUR_KEY"

应用：source ~/.bashrc

Windows PowerShell（管理员）：

[System.Environment]::SetEnvironmentVariable('OPENAI_API_KEY', 'sk-aidesk-YOUR_KEY', 'User')

Windows 命令提示符：

setx OPENAI_API_KEY "sk-aidesk-YOUR_KEY"

验证配置

确认安装和配置：

codex --version

测试 API 连接：

codex "Hi"

如果返回正常回复，说明配置成功。如果遇到错误，请参考下方常见问题。

常见问题

  • 前往控制台 → API 密钥 验证密钥是否正确
  • 确保 OPENAI_API_KEY 环境变量设置正确
  • 设置环境变量后重启终端
  • 检查 API 密钥的有效性
  • 验证账户余额是否充足
  • 确保 API 密钥可以访问所请求的模型
  • 验证网络连接是否正常
  • 确认浏览器可以访问 https://api.aideskapp.com
  • 检查防火墙是否阻止了出站 HTTPS 连接
  • 确认 config.toml 中 base_url 为 https://api.aideskapp.com/v1
  • 编辑 config.toml 后重启终端
  • 验证 TOML 语法（无多余空格，引号正确）
  • 确认配置文件路径对您的操作系统正确
  • 确保文件名为 config.toml（而非 config.toml.txt）
  • Mac/Linux：检查 npm 全局 bin 是否在 PATH 中
  • 如果需要，在 ~/.zshrc 或 ~/.bashrc 中添加：export PATH="$(npm config get prefix)/bin:$PATH"
  • Windows：验证 npm 全局路径是否在系统 PATH 中，安装后重启终端