Codex CLI

使用 CometAPI 設定 OpenAI Codex CLI：在 config.toml 中設定 openai_base_url 或自訂 provider，將你的 API key 儲存在 auth.json，並使用當前模型開始撰寫程式。

使用本指南以 CometAPI 作為模型提供者來執行 Codex CLI。

官方參考資料：

• 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：

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 重新建立
找不到模型	請查看 Models page 以確認可用模型
連線逾時	確認 config.toml 中的 openai_base_url 或 base_url 為 https://api.cometapi.com/v1
Windows 問題	Codex 在 Windows 上需要 WSL2 — 不支援原生 CMD/PowerShell