github/copilot-sdk

GitHub Copilot SDKs

GitHub Copilot SDK 允许您将驱动 Copilot CLI 的相同代理引擎直接嵌入到您自己的应用程序中。官方包适用于 Python、TypeScript/Node.js、Go、.NET、Java 和 Rust。SDK 负责以服务器模式启动 Copilot CLI、通过 JSON-RPC 进行通信，并公开用于规划、工具调用、文件编辑、自定义代理、技能等的高级方法——因此您无需自行构建编排。

您将获得的功能

• 跨六种语言的统一 API——每个 SDK 都镜像了 Copilot CLI 的功能。
• 自动 CLI 管理（Node、Python、.NET 内置；Go、Java、Rust 可选）。
• 代理运行时——执行规划、工具调用和文件修改。
• 自定义代理 / 技能 / 工具——使用您自己的逻辑扩展内置功能。
• 认证选项——GitHub 登录用户、OAuth 应用、环境变量令牌或 BYOK（您自己的 API 密钥，用于 OpenAI、Anthropic 等）。
• 生产就绪——GA 版本、语义化版本控制和变更日志。

快速入门（任何语言）

1. （可选）安装 Copilot CLI——仅 Go、Java 和 Rust 需要，除非您自行捆绑。
2. 安装 SDK
   • Node: npm install @github/copilot-sdk
   • Python: pip install github-copilot-sdk
   • Go: go get github.com/github/copilot-sdk/go
   • .NET: dotnet add package GitHub.Copilot.SDK
   • Rust: cargo add github-copilot-sdk
   • Java: 通过 Maven 或 Gradle 添加 com.github:copilot-sdk-java。
3. 阅读语言特定的 README——查看使用示例和 API 参考。
4. 运行你的代码——SDK 将启动 Copilot CLI 进程，通过 JSON-RPC 与之通信，并让您以编程方式调用代理。

了解更多

• 入门指南 – docs/getting-started.md
• 完整文档索引 – docs/README.md
• 食谱 – 所有语言的常见任务的实用方法。
• 认证文档 – docs/auth/README.md
• 功能指南 – docs/features/README.md

许可与贡献

• 在 MIT 许可下开源。
• 欢迎通过标准的 GitHub 拉取请求工作流程（见 CONTRIBUTING.md）贡献。

---

以上所有信息均直接取自仓库的 README。