GitHub Copilot CLI SDK：多语言集成智能工作流，开发必备！

GitHub Copilot CLI SDK多语言集成 Copilot 智能工作流开发必备借助适用于 Python、TypeScript、Go、.NET、Java 和 Rust 的 GitHub Copilot SDK可将 Copilot 的智能工作流集成到自己的应用程序中。该 SDK 采用与 Copilot CLI 相同的、经过生产环境验证的智能代理运行时能通过编程方式调用。用户无需自行构建编排逻辑只需定义代理行为Copilot 便会处理规划、工具调用、文件编辑等任务。可用的 SDK具体的安装步骤、使用示例和 API 参考可查看各个 SDK 的 README 文件。SDK 语言位置参考手册安装方式Node.js / TypeScriptnodejs/参考手册npm install github/copilot-sdkPythonpython/参考手册pip install github-copilot-sdkGogo/参考手册go get github.com/github/copilot-sdk/go.NETdotnet/参考手册dotnet add package GitHub.Copilot.SDKRustrust/—cargo add github-copilot-sdkJavajava/参考手册Maven 坐标com.github:copilot-sdk-java详见 Maven 和 Gradle 的安装说明快速上手若要获取完整的操作指南可查看《快速上手指南》。快速步骤如下可选安装 Copilot CLI对于 Node.js、Python 和 .NET SDKCopilot CLI 会自动捆绑无需单独安装。对于 Go、Java 和 Rust需手动安装 CLI或确保copilot命令可在系统路径中找到。Go 和 Rust 还提供了应用级别的 CLI 捆绑功能。使用上述命令安装喜欢的 SDK。具体的使用示例和 API 文档可查看 SDK 的 README 文件。架构所有 SDK 都通过 JSON - RPC 与 Copilot CLI 服务器进行通信你的应用程序 ↓ SDK 客户端 ↓ JSON - RPC Copilot CLI服务器模式SDK 会自动管理 CLI 进程的生命周期。也可连接到外部 CLI 服务器具体操作可参考《快速上手指南》中关于以服务器模式运行 CLI 的说明。常见问题解答是否需要 GitHub Copilot 订阅才能使用 SDK是的使用 GitHub Copilot SDK 需要 GitHub Copilot 订阅除非使用 BYOK自带密钥。使用 BYOK 时可通过配置支持的大语言模型LLM提供商的 API 密钥在无需 GitHub 认证的情况下使用 SDK。对于标准使用场景非 BYOK可参考 GitHub Copilot 定价页面其中包含有限使用的免费套餐。SDK 使用如何计费GitHub Copilot SDK 的计费模式与 Copilot CLI 相同每个提示都会计入高级请求配额。有关高级请求的更多信息可查看《GitHub Copilot 中的请求》。是否支持 BYOK自带密钥是的GitHub Copilot SDK 支持 BYOK自带密钥。可配置 SDK 使用支持的 LLM 提供商如 OpenAI、Azure AI Foundry、Anthropic的 API 密钥通过这些提供商访问模型。具体的设置说明和示例可参考 BYOK 文档。注意BYOK 仅支持基于密钥的认证不支持 Microsoft Entra IDAzure 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 SDKCopilot CLI 会作为依赖自动捆绑无需单独安装。对于 Go、Java 和 Rust SDKCLI 默认不捆绑需要手动安装 CLI或确保copilot命令可在系统路径中找到。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 / TypeScriptPython.NETGoRustSDK 指南自定义说明尚未发布Java支持哪些模型SDK 支持通过 Copilot CLI 可用的所有模型。SDK 还提供了一个方法可返回可用的模型以便在运行时访问。SDK 是否适合生产环境GitHub Copilot SDK 已正式发布并遵循语义化版本控制。发布说明可查看CHANGELOG.md。如何报告问题或请求新功能请使用 GitHub Issues 页面报告错误或请求新功能。欢迎反馈以帮助改进 SDK。快速链接文档完整的文档索引快速上手入门教程设置指南架构、部署和扩展认证GitHub OAuth、BYOK 等功能钩子、自定义代理、MCP、技能等故障排除常见问题及解决方案参考手册跨所有语言的常见任务实用配方更多资源额外的示例、教程和社区资源非官方、社区维护的 SDK⚠️ 免责声明这些是非官方的、由社区驱动的 SDKGitHub 不提供支持请自行承担使用风险。SDK 语言位置Clojurecopilot-community-sdk/copilot-sdk-clojureC0xeb/copilot-sdk-cpp贡献贡献指南请查看CONTRIBUTING.md。许可证本项目采用 MIT 许可证。