Copilot CLI

透過官方 BYOK Provider 環境變數，將 GitHub Copilot CLI 接入 CoffeeRouter。

接入前準備

  • 安裝 Node.js 22 或更新版本。
  • 準備 CoffeeRouter API Key 與目標模型 ID。
  • 模型必須支援串流輸出與工具呼叫；官方建議上下文視窗至少為 128K。

設定步驟

1. 安裝 Copilot CLI

npm install -g @github/copilot
copilot --version

如果 ~/.npmrc 中設定了 ignore-scripts=true，請依官方說明使用：

npm_config_ignore_scripts=false npm install -g @github/copilot

Windows 也可以使用 winget install GitHub.Copilot。

2. 設定 CoffeeRouter Provider

CoffeeRouter 提供 OpenAI Chat Completions 相容介面，因此預設使用 openai Provider。

Linux / macOS：

export COPILOT_PROVIDER_TYPE=openai
export COPILOT_PROVIDER_BASE_URL=https://www.coffeerouter.ai/v1
export COPILOT_PROVIDER_API_KEY=sk-your-api-key
export COPILOT_MODEL=your-model-id

Windows PowerShell：

$env:COPILOT_PROVIDER_TYPE="openai"
$env:COPILOT_PROVIDER_BASE_URL="https://www.coffeerouter.ai/v1"
$env:COPILOT_PROVIDER_API_KEY="sk-your-api-key"
$env:COPILOT_MODEL="your-model-id"

將 your-model-id 替換為 CoffeeRouter 令牌允許使用的模型 ID。

3. 啟動並檢查 Provider

copilot

如需查看目前版本支援的 Provider 參數：

copilot help providers

驗證接入

在 Copilot CLI 中傳送一個需要分析專案檔案並呼叫工具的任務。能夠串流回傳結果且工具呼叫正常，即表示接入成功。

常見問題

提示模型不支援

確認模型 ID 完全相同，並確保該模型支援串流輸出與工具呼叫。僅支援一般聊天的模型無法滿足 Copilot CLI Agent 要求。

環境變數沒有生效

在同一個終端視窗中設定變數並啟動 copilot。修改變數後應結束目前工作階段，再重新啟動。

推理模型回傳 400

不同模型對多輪推理內容的回傳要求可能不同。不要把 anthropic 當作所有模型的通用設定；只有在 CoffeeRouter 明確提供對應 Anthropic Messages 端點且經過驗證時，才切換 Provider 類型。也可以先使用非推理模型排查。

為什麼 Base URL 以 /v1 結尾

Copilot CLI 接收 API 基礎位址並自行呼叫 Chat Completions 路徑，所以這裡填寫 https://www.coffeerouter.ai/v1，而不是完整的 /chat/completions 位址。

安全提示

  • Provider 環境變數包含 API Key，請勿分享 shell Profile、終端截圖或診斷記錄。
  • Copilot CLI 會把提示詞、程式碼上下文與工具呼叫資料傳送到 CoffeeRouter。
  • 建議使用獨立令牌，並依需求設定模型、額度、IP 與有效期限限制。
  • 如果使用遠端 CoffeeRouter 服務，請確認營運方的資料處理規則符合您的合規要求。

官方資料