Copilot API完全指南:一个本地AI网关连接Claude Code、Codex与OpenCode到GitHub Copilot
Copilot API完全指南:一个本地AI网关连接Claude Code、Codex与OpenCode到GitHub Copilot
Copilot API 是一个开源的本地 AI 网关:它运行在你自己的电脑上,在同一个本地端口上同时提供 OpenAI 兼容的 Chat Completions、OpenAI Responses 和 Anthropic 兼容的 Messages 三种端点,让 Claude Code、OpenCode、Codex 等编程客户端通过这一个网关,直接调用 GitHub Copilot、内置 Codex / xAI 以及 DeepSeek、Kimi、OpenRouter 等第三方模型服务,并自带 Token 用量看板 🖥️。
🧭 为什么需要 Copilot API:一个网关统一三种协议
不同客户端说的"语言"不一样:Claude Code 走 Anthropic Messages,Codex 走 OpenAI Responses,大量工具走 Chat Completions。Copilot API 在 http://localhost:4141 这一个端点上同时承接这三种协议,并在上游协议不同(provider 使用不同协议)时自动完成协议翻译与路由。
核心能力一览:
- 统一 API 网关:
/v1/chat/completions、/v1/responses、/v1/messages三种端点同一入口; - 多 Provider 接入:GitHub Copilot 是可选能力,配好任意一个第三方 provider(DeepSeek、DashScope、OpenRouter、OpenCode Go 等)即可独立运行,无需 GitHub token;
- 为 Coding Agent 而生:内置 Claude Code、OpenCode、Codex 的完整接入方案和网关模型发现;
- 流式与 WebSocket:三种客户端协议均支持 SSE 流式输出;
- 桌面应用:Electron 图形界面,一键启动/停止、登录、Provider 配置与用量查看。
请求路由逻辑可参考 src/lib/provider-resolver.ts,协议契约定义在 src/lib/types/。
🚀 最快启动方法:npx 一行命令跑起本地网关
环境要求:Node.js >= 22.13.0(或 Bun >= 1.2.x);仅当使用 GitHub Copilot provider 时才需要相应订阅。
npx @jeffreycao/copilot-api@latest start
npx @jeffreycao/copilot-api@latest auth login
curl http://localhost:4141/v1/models
- 第一条:启动网关,默认监听
http://localhost:4141; - 第二条(可选):登录 GitHub Copilot 或配置第三方 provider;
- 第三条:能返回模型列表,说明网关已就绪。
更完整的安装方式(源码运行、Docker Compose 部署、网关 API Key 设置)见 docs/guides/zh-CN/getting-started.md 和 docs/guides/zh-CN/docker.md。
🧩 接入 Claude Code:settings.json 指向本地网关
在项目根目录创建 .claude/settings.json,把 ANTHROPIC_BASE_URL 指向 http://localhost:4141,ANTHROPIC_AUTH_TOKEN 填任意占位值;再设置 CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY: "1",Claude Code 的 /model 菜单就能自动发现网关里的模型(非 Claude 模型会自动加上兼容前缀)。
这份配置里还包含一些值得了解的细节:自动压缩窗口 CLAUDE_CODE_AUTO_COMPACT_WINDOW、prompt cache TTL、关闭不必要的额度消耗项等。每个变量的作用和完整推荐配置见 docs/guides/zh-CN/claude-code.md。
🧩 接入 Codex:config.toml 指向本地网关
在 ~/.codex/config.toml 中新增一个 copilot_api provider 块,把 base_url 和 model_catalog_url 分别指向 http://localhost:4141 与 http://localhost:4141/models,wire_api 设为 responses,并设置环境变量 GITHUB_COPILOT_API_KEY 为网关 API Key(未启用鉴权时填任意非空占位值即可)。
几个实用点:
- Codex 0.160.0+ 会直接从
model_catalog_url拉取合并后的模型目录,本地文件可选; - 需要完整本地目录时,一键运行 docs/generate-model-catalog.sh 生成;
- 完整的参考配置块、自动审核模型映射与协议适配说明见 docs/guides/zh-CN/codex.md。
配置完成后,Codex 的模型选择器会列出网关提供的所有模型:
🧩 接入 OpenCode:一个插件文件自动发现模型
OpenCode v2 用户只需把仓库里的 plugin/opencode/copilot-api-provider.js 复制到项目的 .opencode/plugins/(或 ~/.config/opencode/plugins/ 供所有项目使用),重启即可——插件会通过 Responses 协议自动发现网关模型并每 20 秒刷新一次,同时启用原生压缩,无需手动维护模型列表。
v1 用户则可用 @ai-sdk/anthropic 方式接入。细节与模型能力、上下文上限说明见 docs/guides/zh-CN/opencode.md。
🖥️ 桌面应用:免命令行的登录、启动与 Provider 配置
不喜欢命令行?desktop/ 目录下的 Electron 桌面应用把一切都做成了图形界面:GitHub Copilot 登录、Codex 与 xAI OAuth、第三方 provider 的 API Key 配置、一键启动/停止本地服务,并在一个窗口内直接查看本地端点、鉴权 Header、可用模型、额度与日志。
在 Providers 页可以为每个 provider 选择"向 coding agent 展示哪些模型",保存后运行中的服务会自动刷新配置:
桌面应用的完整指南(各平台安装包、自动更新、高级设置)见 docs/guides/zh-CN/desktop.md。
📊 用量监控:Copilot 额度与 Token 花费一目了然
服务启动后控制台会打印一个 usage viewer 的 URL,浏览器打开即可看到:Copilot 配额进度条、Token 指标卡(Total / Input / Output / Cache Read / Cache Write / 预估费用)、按模型与周期筛选的趋势图、模型维度统计和分页的请求事件列表:
桌面应用的 Token usage 页提供同样的数据,还带 30 天每日趋势折线图:
用法详情见 docs/guides/zh-CN/usage.md。
🔍 常见问题与文档索引
遇到配置问题,按下面这份索引快速定位:
| 场景 | 文档 |
|---|---|
| 安装、源码运行、Docker、provider-only 模式 | docs/guides/zh-CN/getting-started.md |
| Claude Code 配置与插件集成 | docs/guides/zh-CN/claude-code.md、docs/guides/zh-CN/integrations.md |
| Codex config.toml 参考配置 | docs/guides/zh-CN/codex.md |
| OpenCode v1/v2 接入 | docs/guides/zh-CN/opencode.md |
| 桌面应用 | docs/guides/zh-CN/desktop.md |
| 用量监控 | docs/guides/zh-CN/usage.md |
config.json 全部字段 |
docs/guides/zh-CN/configuration.md |
| API 端点与认证 | docs/guides/zh-CN/api.md |
| CLI 命令参考 | docs/guides/zh-CN/cli.md |
| 故障排查(如 Copilot 模型列表缺 Claude 模型) | docs/guides/zh-CN/troubleshooting.md |
⚠️ 安全提示:使用 GitHub Copilot 前,请先阅读 NOTICE.md 中的 GitHub Copilot 安全提示,确认使用方式符合你的订阅与合规要求。
一个本地端点,三种协议,多 Provider 自由路由——把 Copilot API 跑起来,你的 Claude Code、Codex 和 OpenCode 就都有了统一的模型入口 🚀。




