Build AI agents GitHub Copilot SDK 公开
GitHub Copilot SDK 介绍
简介
GitHub Copilot SDK 是一个多平台的软件开发工具包,允许开发者将 GitHub Copilot Agent 集成到自己的应用程序和服务中。通过这个 SDK,你可以在自己的代码中以编程方式调用 GitHub Copilot CLI 的功能。
注意:目前所有 SDK 都处于技术预览阶段,在正式发布之前可能会有破坏性的变更。
支持的语言平台
| 语言 | 安装命令 |
|---|---|
| Node.js / TypeScript | npm install [@github](/user/github/about)/copilot-sdk |
| Python | pip install github-copilot-sdk |
| Go | go get github.com/github/copilot-sdk/go |
| .NET | dotnet add package GitHub.Copilot.SDK |
核心功能
- 编程式访问 Copilot CLI:通过代码调用 GitHub Copilot 命令行工具的各种功能
- 多语言支持:提供 JavaScript/TypeScript、Python、Go、C# 等主流语言的 SDK
- 进程管理:SDK 自动管理 Copilot CLI 进程的生命周期
- 灵活连接:支持连接到外部 CLI 服务器
工作原理
所有 SDK 通过 JSON-RPC 协议与 Copilot CLI 服务器进行通信:
复制
你的应用程序
↓
SDK 客户端
↓ JSON-RPC
Copilot CLI(服务器模式)
快速开始
第一步:安装 Copilot CLI
按照 Copilot CLI 安装指南 安装 CLI,或确保 copilot 命令在你的 PATH 环境变量中可用。
第二步:安装 SDK
根据你使用的编程语言,选择对应的安装命令(见上表)。
第三步:开始使用
查看各个语言 SDK 的 README 文档,了解具体的使用示例和 API 参考。
许可证
MIT
资源链接
- GitHub 仓库: https://github.com/github/copilot-sdk
- 贡献指南:参见仓库中的 CONTRIBUTING.md
- 安全政策:参见仓库中的 SECURITY.md
前排学习学习