GitHub Copilot SDK发布，六语言生态初成型

让每个应用都拥有 Agent。

借助适用于 Python、TypeScript、Go、.NET、Java 和 Rust 的 GitHub Copilot SDK，将 Copilot 的 Agent 工作流嵌入你的应用程序。

GitHub Copilot SDK 开放了 Copilot CLI 背后的同一套引擎：一个经过生产环境验证、可通过编程方式调用的 Agent Runtime。你无需自行构建编排系统——只需定义 Agent 的行为，规划、工具调用、文件编辑等工作都由 Copilot 处理。

有关安装、使用示例和 API 参考，请参阅各语言 SDK 的 README。

如需完整的操作指南，请参阅入门指南。

（可选）安装 Copilot CLI

对于 Node.js、Python 和 .NET SDK，Copilot CLI 已自动捆绑，无需单独安装。对于 Go、Java 和 Rust，请手动安装 CLI，或确保 copilot 已加入 PATH。Go 和 Rust 还提供应用级 CLI 捆绑功能。

使用上面的命令安装你需要的 SDK。

使用上面的命令安装你需要的 SDK。

有关使用示例和 API 文档，请参阅 SDK README。

有关使用示例和 API 文档，请参阅 SDK README。

所有 SDK 都通过 JSON-RPC 与 Copilot CLI 服务器通信：

Your Application
       ↓
  SDK Client
       ↓ JSON-RPC
  Copilot CLI (server mode)

SDK 会自动管理 CLI 进程的生命周期。你也可以连接外部 CLI 服务器——有关如何以服务器模式运行 CLI 的详细信息，请参阅入门指南。

使用 SDK 是否需要订阅 GitHub Copilot？

需要。使用 GitHub Copilot SDK 必须订阅 GitHub Copilot，除非你使用 BYOK（Bring Your Own Key，自带密钥）。使用 BYOK 时，你可以配置受支持 LLM 提供商的自有 API key，无需通过 GitHub 身份验证即可使用 SDK。对于标准用法（非 BYOK），请参阅 GitHub Copilot 定价页面，其中包含用量有限的免费套餐。

SDK 的使用费用如何计算？

GitHub Copilot SDK 采用与 Copilot CLI 相同的计费模式，每个 prompt 都会计入你的用量额度。有关 Copilot 用量计费的更多信息，请参阅 GitHub Copilot 中的“用量”文档。

是否支持 BYOK（Bring Your Own Key）？

支持。GitHub Copilot SDK 支持 BYOK（Bring Your Own Key，自带密钥）。你可以配置 SDK，使用来自受支持 LLM 提供商（例如 OpenAI、Microsoft Foundry、Anthropic）的自有 API key，通过这些提供商访问模型。有关配置说明和示例，请参阅 BYOK 文档。

注意：BYOK 仅支持基于密钥的身份验证。不支持 Microsoft Entra ID（Azure AD）、托管身份和第三方身份提供商。

支持哪些身份验证方式？

SDK 支持多种身份验证方式：

• 已登录 GitHub 的用户——使用 copilot CLI login 保存的 OAuth 凭据
• OAuth GitHub App——传入来自你的 GitHub OAuth App 的用户 token
• 环境变量——COPILOT_GITHUB_TOKEN、GH_TOKEN、GITHUB_TOKEN
• BYOK——使用你自己的 API key（无需 GitHub 身份验证）

有关每种方式的详细信息，请参阅身份验证文档。

是否需要单独安装 Copilot CLI？

不需要——对于 Node.js、Python 和 .NET SDK，Copilot CLI 会作为依赖项自动捆绑，无需单独安装。

对于 Go、Java 和 Rust SDK，默认不会捆绑 CLI。请手动安装 CLI，或确保 copilot 已加入 PATH。Go 和 Rust 还提供应用级 CLI 捆绑功能。

进阶用法：你可以覆盖 CLI 二进制文件，或连接外部服务器。有关各语言的具体选项，请参阅对应 SDK 的 README。

默认启用了哪些工具？

默认情况下，SDK 会开放 Copilot CLI 的第一方工具，效果类似于使用 --allow-all 运行 CLI。工具执行仍然由各 SDK 的权限处理器管理，因此应用程序可以批准、拒绝工具调用，或对其进行定制。你可以配置 SDK Client 选项，启用或禁用特定工具，从而自定义可用工具。有关工具配置的详细信息，请参阅各 SDK 的文档；有关可用工具列表，请参阅 Copilot CLI 文档。

可以使用自定义 Agent、Skill 或工具吗？

可以。GitHub Copilot SDK 允许你定义自定义 Agent、Skill 和工具。你可以实现自己的逻辑，并按需集成其他工具，从而扩展 Agent 的功能。有关更多信息，请参阅你所选语言对应的 SDK 文档。

是否有能帮助 Copilot 加快开发速度的指令或 SDK 指南？

有，请查看自定义指令和针对各 SDK 的指南：

• Rust（SDK 指南；自定义指令尚未发布）

支持哪些模型？

SDK 支持 Copilot CLI 中提供的所有模型。SDK 还提供了一个方法，用来返回当前可用的模型，以便在运行时访问它们。

SDK 是否已经可以用于生产环境？

GitHub Copilot SDK 已正式发布，并遵循语义化版本规范。有关发布说明，请参阅 CHANGELOG.md。

如何报告问题或提出功能请求？

请通过 GitHub Issues 页面报告 bug 或提出新功能请求。欢迎提供反馈，帮助我们不断改进 SDK。

• 文档——完整的文档索引
• 入门指南——帮助你开始使用的教程
• 配置指南——架构、部署与扩展
• 身份验证——GitHub OAuth、BYOK 等
• 功能——Hook、自定义 Agent、MCP、Skill 等
• 故障排查——常见问题及解决方案
• Cookbook——适用于所有语言的常见任务实用配方
• 更多资源——更多示例、教程和社区资源

非官方、由社区维护的 SDK

⚠️ 免责声明：这些是由社区推动的非官方 SDK，不受 GitHub 支持。使用风险由你自行承担。

有关贡献指南，请参阅 CONTRIBUTING.md。