GitHub Copilot CLI SDKs

适用于各类应用的智能体。

借助适用于 Python、TypeScript、Go、.NET、Java 和 Rust 的 GitHub Copilot SDK，将 Copilot 的智能体工作流嵌入到您的应用程序中。

GitHub Copilot SDK 公开了 Copilot CLI 背后的同款引擎：一个经过生产环境测试的智能体运行时，您可以通过编程方式调用它。无需构建自己的编排系统——您只需定义智能体行为，Copilot 会处理规划、工具调用、文件编辑等工作。

可用 SDK

SDK	位置	指南	安装方式	API 文档
Node.js / TypeScript	nodejs/	指南	npm install @github/copilot-sdk
Python	python/	指南	pip install github-copilot-sdk
Go	go/	指南	go get github.com/github/copilot-sdk/go	API 文档
.NET	dotnet/	指南	dotnet add package GitHub.Copilot.SDK
Rust	rust/	—	cargo add github-copilot-sdk	API 文档
Java	java/	指南	Maven 坐标 com.github:copilot-sdk-java 参见 Maven 和 Gradle 的安装说明	API 文档

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

快速开始

如需完整的操作指南，请参阅 快速开始指南。

快速步骤：

1. （可选）安装 Copilot CLI

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

2. 使用上述命令安装您首选的 SDK。

3. 查看 SDK README 获取使用示例和 API 文档。

架构

所有 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（自带密钥）。通过 BYOK，您可以通过配置来自受支持 LLM 提供商的自有 API 密钥，在无需 GitHub 身份验证的情况下使用 SDK。对于标准使用场景（非 BYOK），请参考 GitHub Copilot 定价页面，其中包含具有使用限制的免费套餐。

SDK 使用的计费方式是怎样的？

GitHub Copilot SDK 的计费基于与 Copilot CLI 相同的模型，每个提示都会计入您的使用额度。有关 Copilot 使用计费的更多信息，请参阅 GitHub Copilot 中的使用情况。

它是否支持 BYOK（自带密钥）？

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

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

支持哪些身份验证方法？

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

• GitHub 已登录用户 - 使用 copilot CLI 登录存储的 OAuth 凭据
• OAuth GitHub 应用 - 传递来自您的 GitHub OAuth 应用的用户令牌
• 环境变量 - COPILOT_GITHUB_TOKEN、GH_TOKEN、GITHUB_TOKEN
• BYOK - 使用您自己的 API 密钥（无需 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 客户端选项来启用和禁用特定工具，从而自定义工具的可用性。有关工具配置的详细信息，请参考各个 SDK 的文档；有关可用工具的列表，请参考 Copilot CLI 文档。

能否使用自定义代理、技能或工具？

可以，GitHub Copilot SDK 允许您定义自定义代理、技能和工具。您可以通过实现自己的逻辑并根据需要集成其他工具来扩展代理的功能。有关更多详细信息，请参考您首选语言的 SDK 文档。

是否有关于 Copilot 的使用说明或 SDK 指南以加快开发速度？

有，请查看自定义说明和特定于 SDK 的指南：

• Node.js / TypeScript
• Python
• .NET
• Go
• Rust（SDK 指南；自定义说明尚未发布）
• Java

支持哪些模型？

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

SDK 是否已准备好投入生产使用？

GitHub Copilot SDK 已正式发布，并遵循语义化版本控制。发布说明请参见 CHANGELOG.md。

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

请使用 GitHub Issues 页面报告错误或请求新功能。我们欢迎您的反馈，以帮助改进 SDK。

快速链接

• 文档 – 完整文档索引
• 快速入门 – 启动和运行的教程
• 设置指南 – 架构、部署和扩展
• 身份验证 – GitHub OAuth、BYOK 等
• 功能 – 钩子、自定义代理、MCP、技能等
• 故障排除 – 常见问题和解决方案
• 开发指南 – 适用于所有语言常见任务的实用方法
• 更多资源 – 其他示例、教程和社区资源

非官方、社区维护的 SDK

⚠️ 免责声明：这些是非官方的、社区驱动的 SDK，不受 GitHub 支持。使用风险自负。

SDK	位置
Clojure	copilot-community-sdk/copilot-sdk-clojure
C++	0xeb/copilot-sdk-cpp

贡献指南

贡献指南请参见 CONTRIBUTING.md。

许可证

MIT