跳轉到主要內容

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.

使用本指南可將 Codex CLI 與 CometAPI 搭配作為 model provider 執行。 官方參考資料：
Codex 必須同時設定這兩個檔案：~/.codex/config.toml 與 ~/.codex/auth.json。請勿在此整合中僅使用 base-URL 設定。

​
先決條件

RequirementDetails
作業系統macOS 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 會提示你選擇主題並確認安全性設定。

​
疑難排解

SymptomFix
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