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 服务,请确认运营方的数据处理规则满足您的合规要求。

官方资料