Codex CLI

概覽

類型: Coding Tool主要路徑: OpenAI Responses（進階可選路徑）支援信心: 在模型/路徑限制下受到支援

OpenAI Codex 是一個開源的命令列工具（CLI），作為輕量的程式撰寫代理，能在終端機中閱讀、修改與執行程式碼。它建構於 GPT 模型之上，並針對程式碼生成進行最佳化。對於 TokenLab，Codex CLI 可以使用 /v1/responses，但您應將其視為進階相容路徑。某些僅限 Responses 的功能並不保證在每個模型與路由上都可用。 Codex CLI 遠端壓縮支援 POST /v1/responses/compact。Codex 在 /compact 和自動壓縮時會把目前工作階段的 model 放在 body.model 中，因此請確保要用於壓縮的模型在 Responses 路徑上可用；不要設定 /v1/compact。

系統需求

OS: macOS、Linux（官方支援）、透過 WSL 的 Windows
Node.js: 版本 18+
npm: 版本 10.x.x 或更高

安裝

npm install -g @openai/codex

驗證安裝：

codex --version

設定

第 1 步：設定 API Key

暫時（當前工作階段）:

export OPENAI_API_KEY="sk-your-tokenlab-key"

永久設定: 加入至 ~/.bashrc、~/.zshrc 或 ~/.bash_profile：

export OPENAI_API_KEY="sk-your-tokenlab-key"

然後重新載入：

source ~/.zshrc  # or source ~/.bashrc

第 2 步：設定 config.toml

編輯 ~/.codex/config.toml：

model_provider = "tokenlab"
model = "gpt-5.6-sol"
model_reasoning_effort = "xhigh"
plan_mode_reasoning_effort = "xhigh"
model_context_window = 258000
model_auto_compact_token_limit = 232200
sandbox_mode = "danger-full-access"
approval_policy = "never"

personality = "friendly"
service_tier = "fast"

[model_providers.tokenlab]
env_key = "OPENAI_API_KEY"
name = "TokenLab"
base_url = "https://api.tokenlab.sh/v1"
wire_api = "responses"
supports_websockets = true
websocket_connect_timeout_ms = 15000

[features]
fast_mode = true

此 WebSocket 模式是面向 Codex 用戶端的 Responses-over-WebSocket 橋接層。它只接受官方 response.create 事件；stream 為隱含行為，此 transport 不提供 background 或 response.cancel。它不是 OpenAI Realtime API，也不接受 session.update、conversation.item.*、input_audio_buffer.*、二進位音訊或巢狀 Realtime response.create.response 信封。

如果配置檔不存在，請先執行一次 codex 以產生它，然後編輯該檔案。修改 config.toml 後請完全重新啟動 Codex，以便重新載入新的提供者設定。

Codex 正在逐步淘汰對自訂提供者的 chat/completions 支援。除非您刻意使用舊的相容路徑，否則對 TokenLab 保持 wire_api = "responses"。

TokenLab 會 best-effort 透傳未知 Responses 欄位，不會將請求悄悄降級成 Chat Completions；欄位或組合是否支援由選中的 upstream 決定。

基本用法

啟動互動模式:

codex

直接指令:

codex "Fix the bug in main.py line 42"

指定模型:

codex -m gpt-5.6-sol "Build a REST API server"

模型	適用情境
`gpt-5.6-sol`	程式編寫與推理的最佳預設選擇
`gpt-5-mini`	更快速、更便宜的程式工作流程備援
`claude-sonnet-4-6`	程式碼審查、文件撰寫
`deepseek-r1`	演算法設計、推理

互動指令

指令	說明
`/help`	顯示說明
`/exit` 或 `Ctrl+C`	退出
`/clear`	清除對話
`/config`	檢視設定
`/model <name>`	切換模型
`/tokens`	檢視 token 使用情況

驗證設定

# Check environment variable
echo $OPENAI_API_KEY

# Test API connection
codex "Hello, Codex!"

# View configuration
cat ~/.codex/config.toml

常見用例

程式碼審查:

git diff | codex "Review these code changes"

產生 commit 訊息:

git diff --staged | codex "Generate a commit message for these changes"

修復錯誤:

codex "Fix the TypeScript errors in src/components/"

解釋程式碼:

cat main.py | codex "Explain what this code does"

故障排除

連線錯誤

驗證 base_url 在 config.toml 中是否為 https://api.tokenlab.sh/v1
檢查網路連線
確保沒有代理干擾

認證失敗

驗證 env_key = "OPENAI_API_KEY" 是否存在於 ~/.codex/config.toml
驗證 OPENAI_API_KEY 環境變數是否已設定
檢查金鑰是否以 sk- 開頭
確保該金鑰在 TokenLab 儀表板中為啟用狀態

找不到模型

檢查模型名稱是否完全相符
在 tokenlab.sh/en/models 驗證模型的可用性

Responses 原生欄位被拒絕

某些欄位僅在 TokenLab 能為所選模型與路由保證該行為時，才在 /v1/responses 上可用
若您看到 unsupported_request_field，請移除該欄位或切換至不依賴該欄位的工作流程

/compact 或自動壓縮失敗

Codex CLI 會呼叫 POST /v1/responses/compact，不是 /v1/compact
壓縮請求使用目前工作階段的 model，因此該模型必須在 Responses 路徑上可用
保持 wire_api = "responses" 和 base_url = "https://api.tokenlab.sh/v1"

相容性矩陣

程式工具

原生 SDK

框架與平台

聊天應用

概覽

系統需求

安裝

設定

第 1 步：設定 API Key

第 2 步：設定 config.toml

基本用法

推薦模型

互動指令

驗證設定

常見用例

故障排除

​概覽

​系統需求

​安裝

​設定

​第 1 步：設定 API Key

​第 2 步：設定 config.toml

​基本用法

​推薦模型

​互動指令

​驗證設定

​常見用例

​故障排除

概覽

系統需求

安裝

設定

第 1 步：設定 API Key

第 2 步：設定 config.toml

基本用法

推薦模型

互動指令

驗證設定

常見用例

故障排除