Codex CLI

使用 CometAPI 设置 OpenAI Codex CLI：在 config.toml 中配置 openai_base_url 或自定义 provider，在 auth.json 中存储你的 API key，并使用当前模型开始编码。

使用本指南将 Codex CLI 与 CometAPI 一起作为模型提供方运行。

官方参考：

• Codex CLI README
• Codex Authentication
• Codex Advanced Configuration

模型可用性经常变化。以下示例使用 your-model-id —— 请将其替换为来自 CometAPI Models page 的当前适合编码的 model ID。

​

前置要求

要求	详情
OS	macOS 12+、Linux（Ubuntu 20.04+ / Debian 10+），或通过 WSL2 运行的 Windows 11
Node.js	22+（推荐 LTS）
Git	推荐 2.23+
CometAPI key	从 CometAPI Dashboard 获取一个（以 sk- 开头）

​

安装 Codex CLI

npm i -g @openai/codex

或者通过 Homebrew：

brew install --cask codex

验证安装：

codex --version

​

配置 CometAPI

有两种方式可以让 Codex 指向 CometAPI。选择最适合你工作流的方式。

Simple: openai_base_url

最简单的选项——用一行配置将内置的 OpenAI provider 重定向到 CometAPI。 无需定义自定义 provider。

创建 ~/.codex/config.toml：

model = "your-model-id"
openai_base_url = "https://api.cometapi.com/v1"

Named provider

定义一个名为 cometapi 的 provider。当你希望使用 --profile 或 model_provider 在多个 provider 之间切换时，这种方式会很有用。

创建 ~/.codex/config.toml：

model = "your-model-id"
model_provider = "cometapi"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
env_key = "OPENAI_API_KEY"

env_key 会告诉 Codex 哪个环境变量 保存了你的 API key。 Codex 会在运行时读取 OPENAI_API_KEY 的值——这不是你实际的 key。

​

存储你的 API key

创建 ~/.codex/auth.json：

{
  "OPENAI_API_KEY": "sk-your-cometapi-key"
}

将 sk-your-cometapi-key 替换为你实际的 CometAPI key。

此文件是必需的。 如果 auth.json 中没有有效的 OPENAI_API_KEY 条目， Codex 会以 API key auth is missing a key 退出。

​

启动 Codex

cd your-project
codex

首次启动时，Codex 会提示你选择主题并确认安全设置。

​

按会话覆盖 model

无需编辑 config.toml，即可在单次运行中切换到其他 model：

codex --model your-model-id

​

替代方案：环境变量

你也可以不使用 auth.json，而是直接导出 key：

export OPENAI_API_KEY="sk-your-cometapi-key"
codex

这只会为当前终端会话设置该 key。若要持久生效，请将 export 这一行添加到 ~/.zshrc 或 ~/.bashrc。

​

故障排查

症状	解决方法
API key auth is missing a key	确保 ~/.codex/auth.json 包含 "OPENAI_API_KEY": "sk-..."
意外出现登录提示	删除旧的 ~/.codex/auth.json 并使用你的 CometAPI key 重新创建
找不到 model	查看 Models page 了解可用模型
连接超时	确认 config.toml 中的 openai_base_url 或 base_url 为 https://api.cometapi.com/v1
Windows 问题	Codex 在 Windows 上需要 WSL2——不支持原生 CMD/PowerShell