跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt

Use this file to discover all available pages before exploring further.

使用本指南可将 CometAPI 作为 model provider 来运行 Codex CLI。 官方参考：
Codex 必须同时配置这两个文件：~/.codex/config.toml 和 ~/.codex/auth.json。请勿在此集成中仅使用 base-URL 的设置方式。

​
前提条件

要求详情
OSmacOS 12+、Linux（Ubuntu 20.04+ / Debian 10+），或通过 WSL2 运行的 Windows 11
Node.js22+（推荐 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/config.toml，添加以下 provider 配置： 
model_provider = "cometapi"
model = "gpt-5.5"

[model_providers.cometapi]
name = "CometAPI"
base_url = "https://api.cometapi.com/v1"
requires_openai_auth = true
model_provider 和 model 键必须保留在文件的顶层。 [model_providers.cometapi] 部分定义了 CometAPI endpoint。
如果你通过 dotfiles 仓库管理 Codex 设置，请确保 dotfiles 中的副本 与 ~/.codex/config.toml 保持同步。Codex 会从 ~/.codex/config.toml 读取该文件。

​
存储你的 API key

创建 ~/.codex/auth.json： 
{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "sk-your-cometapi-key"
}
将 sk-your-cometapi-key 替换为你实际的 CometAPI key。
此文件是必需的。auth_mode 必须为 apikey，并且 OPENAI_API_KEY 必须包含你的 CometAPI key。

​
启动 Codex

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

​
故障排查

症状解决方法
API key auth is missing a key修复 ~/.codex/auth.json。它必须包含 "auth_mode": "apikey" 和 "OPENAI_API_KEY": "sk-..."
意外出现登录提示重新创建 ~/.codex/auth.json，并将 auth_mode 设置为 apikey，然后重启 Codex
Codex 仍然使用默认的 OpenAI provider修复 ~/.codex/config.toml。model_provider 必须为 cometapi
请求未到达 CometAPI修复 ~/.codex/config.toml。[model_providers.cometapi] 必须包含 requires_openai_auth = true
连接超时或 endpoint 错误修复 ~/.codex/config.toml。base_url 必须为 https://api.cometapi.com/v1
找不到模型查看可用模型的 Models page
Windows 问题Codex 在 Windows 上需要 WSL2——不支持原生 CMD/PowerShell