程式工具
Codex CLI
設定 OpenAI Codex CLI 以使用 TokenLab API
讓我的 Agent 設定此項目
將此任務複製到已在您電腦上執行的 Agent:
Read this guide and help me connect Codex CLI to TokenLab:
https://tokenlab.sh/docs/zh-TW/integrations/codex-cli
Check my installed version and active configuration first.
Preserve existing accounts, providers, permissions and other settings.
Back up local files and show proposed changes.
Have me enter any API key locally; never ask for, print or paste it in chat.
Check configuration loading first.
Explain any paid request test separately before running it.概觀
Codex CLI 可透過 /v1/responses 連線至 TokenLab。所選模型必須在 tokenlab.accepted_request_formats 中列出 openai_responses;支援的功能因模型而異。
遠端壓縮使用 POST /v1/responses/compact。Codex 會在 body.model 中傳送目前的 session 模型,因此該模型也必須支援 Responses。請勿設定 /v1/compact。
系統需求
macOS、Linux 或 Windows 請參閱官方 CLI 安裝指南。原生 Windows 與 WSL 為不同環境;請遵循 Windows 指南。下方的 npm 指令只是其中一種安裝選項,並非原生二進位檔的必要條件。
安裝
npm install -g @openai/codex@0.163.0驗證安裝:
codex --version設定
步驟 1:設定 API Key
使用 macOS、Linux、WSL 或 Windows PowerShell 的快速入門終端機說明來設定 TOKENLAB_API_KEY,避免將金鑰寫入指令歷程記錄中。從該終端機啟動 Codex。若要持久化使用,請使用本機機密管理工具;請勿將明文金鑰附加至您的 shell profile。
步驟 2:設定 tokenlab.config.toml
在 Codex 0.163.0(測試於 2026-10-18)中,於有效的 CODEX_HOME(通常為 ~/.codex)使用獨立的 tokenlab.config.toml。僅在該名稱尚未使用時建立,若已有 TokenLab profile,請在編輯前先行備份。下方的 profile 是透過 codex --profile tokenlab 明確載入;它會保留預設的 config.toml、auth.json、帳戶及權限原則不變。請勿使用舊版的 [profiles.tokenlab] 表格。不指定 profile 啟動即可返回一般設定。請參閱官方 profile 設定。
model_provider = "tokenlab"
model = "gpt-5.6-sol"
model_reasoning_effort = "xhigh"
[model_providers.tokenlab]
env_key = "TOKENLAB_API_KEY"
name = "TokenLab"
base_url = "https://api.tokenlab.sh/v1"
wire_api = "responses"
supports_websockets = true
websocket_connect_timeout_ms = 15000此 WebSocket 模式是專為 Codex 用戶端設計的 Responses-over-WebSocket 橋接。它僅接受官方的 response.create 事件;stream 為隱式啟用,且此傳輸模式下不提供 background 與 response.cancel。這不是 OpenAI Realtime API,且不接受 session.update、conversation.item.*、input_audio_buffer.*、二進位音訊或巢狀 Realtime response.create.response 封套。
若所選的設定檔不存在,請先建立。編輯完成後,請使用下方相應的指令啟動新的 session。
目前的 Codex 使用 wire_api = "responses"。請勿設定 chat/completions。針對此自訂 provider,請將 requires_openai_auth 保持未設定或設為 false,以確保使用 env_key。
Responses 請求不會轉換為 Chat Completions。選填欄位與未來擴充欄位將取決於所選的模型。
基本用法
啟動互動模式:
codex --profile tokenlab直接執行指令:
codex --profile tokenlab "Fix the bug in main.py line 42"指定模型:
codex --profile tokenlab -m gpt-5.6-sol "Build a REST API server"選擇模型
請使用目前在 tokenlab.accepted_request_formats 中列出 openai_responses 的模型。您可以在自己的編程任務上評估比較各個候選模型,並在模型頁面查看即時價格。
互動指令
| 指令 | 說明 |
|---|---|
/help | 顯示說明 |
/exit 或 Ctrl+C | 離開 |
/clear | 清除對話 |
/status | 顯示使用中的模型、權限與 token 使用量 |
/model <name> | 切換模型 |
驗證設定
檢查環境變數是否已設定,且不印出其值。此檢查不會驗證金鑰的有效性:
if [ -n "${TOKENLAB_API_KEY:-}" ]; then
printf '%s\n' 'TOKENLAB_API_KEY is set'
else
printf '%s\n' 'TOKENLAB_API_KEY is not set'
fi啟動 Codex 並執行 /status 以檢查使用中的模型與權限。如果您使用 profile,請啟動同一個 profile。請參閱官方 status 指令。
當您準備好發送實際請求時,請執行以下指令。這將扣除您的 TokenLab 餘額。請檢查回覆以及在 Requests 中的對應記錄;僅確認環境或成功啟動並不能證明請求已成功執行。
codex --profile tokenlab "Reply only with OK. Do not use tools or modify files."常見使用案例
程式碼審查:
git diff | codex --profile tokenlab "Review these code changes"產生 commit 訊息:
git diff --staged | codex --profile tokenlab "Generate a commit message for these changes"修復錯誤:
codex --profile tokenlab "Fix the TypeScript errors in src/components/"解釋程式碼:
cat main.py | codex --profile tokenlab "Explain what this code does"在同一個 Agent 中產生圖片與影片
Codex 也可以搭配 TokenLab MCP 伺服器建立圖片與短片。每次產生都會從相同的 TokenLab 餘額扣款。請在已設定 TOKENLAB_API_KEY 的終端機中執行:
codex mcp add \
--env TOKENLAB_MCP_TOOL_PROFILE=core \
--env TOKENLAB_API_KEY="$TOKENLAB_API_KEY" \
tokenlab -- \
npx -y @tokenlabai/mcp-server@0.6.48此指令會將伺服器新增至您的基礎 config.toml。Codex 在使用 tokenlab.config.toml profile 時也會載入該檔案,因此無論是否加上 --profile tokenlab,工具都能正常運作。執行 codex mcp list 並確認 tokenlab 已列出。接著嘗試:
Call get_model_pricing for nano-banana-2, then use create_image with nano-banana-2 at 1k to make a photo of a matte black coffee mug on a white desk.create_video 會返回 task ID。Agent 會持續呼叫 get_task_status 直到影片準備完成。