Skip to main content
Codex CLI 是 OpenAI 官方的终端 AI 编程代理。通过 DeerAPI 作为自定义 Provider，你可以在终端中稳定使用。 官方参考：
模型会动态变化，请在调用前查看 DeerAPI 实时定价页： https://api.deerapi.com/pricing

​
前置条件

要求说明
操作系统macOS 12+、Linux (Ubuntu 20.04+ / Debian 10+)、或 Windows 11 (WSL2)
Node.js22+（建议 LTS）
Git2.23+ 推荐
DeerAPI Key在 DeerAPI 控制台 获取（以 sk- 开头）

​
接入步骤

1

安装 Codex CLI

npm i -g @openai/codex
或通过 Homebrew：
brew install --cask codex
验证安装：
codex --version
2

创建 config.toml

创建文件 ~/.codex/config.toml：
model = "gpt-4.1"
model_provider = "deerapi"

[model_providers.deerapi]
name = "DeerAPI"
base_url = "https://api.deerapi.com/v1"
env_key = "OPENAI_API_KEY"
env_key 告诉 Codex 读取哪个环境变量作为 API Key， 而不是直接填入你的 Key。Codex 运行时会读取 OPENAI_API_KEY 的值。
3

写入 auth.json（必需）

创建或编辑 ~/.codex/auth.json：
{
  "OPENAI_API_KEY": "<DEERAPI_KEY>"
}
将 <DEERAPI_KEY> 替换为你的实际 DeerAPI Key。
此文件是必需的。 如果 auth.json 中没有 OPENAI_API_KEY 条目， Codex 会直接报错退出：API key auth is missing a key。
4

启动 Codex

cd your-project
codex
首次启动时会提示选择主题和确认安全设置。

​
替代方式：环境变量

也可以不使用 auth.json，直接导出环境变量： 
export OPENAI_API_KEY="<DEERAPI_KEY>"
codex
此方式仅对当前终端会话生效。如需持久化，将 export 行添加到 ~/.zshrc 或 ~/.bashrc。

​
常见问题

现象解决方案
API key auth is missing a key确保 ~/.codex/auth.json 中包含 "OPENAI_API_KEY": "sk-..."
出现登录提示删除旧的 ~/.codex/auth.json 并用 DeerAPI Key 重新创建
模型不可用查看定价页确认当前可用模型
连接超时确认 config.toml 中 base_url 为 https://api.deerapi.com/v1
Windows 问题Codex 需要 WSL2 环境，不支持原生 CMD/PowerShell