github/copilot-sdk
Multi-platform SDK for integrating GitHub Copilot Agent into apps and services
snapshot: 2026-06-05
scraped_at: 2026/06/05 1:52
period stars: +38
stars: 8,986
forks: 1,211
Language: Java
Summary
一覧カードと同じ provider の要約本文です。
Highlights
GitHub Copilot SDKは、Copilot CLIと同じエンジンをアプリケーションからプログラム的に呼び出せるマルチプラットフォームSDKです。Python、TypeScript/Node.js、Go、.NET、Java、Rust向けのSDKを提供し、エージェントのプランニング、ツール呼び出し、ファイル編集などのオーケストレーションを自前で作らずに利用できます。各SDKは経由でCopilot CLI（サーバーモード）と通信し、SDKがCLIプロセスのライフサイクルを自動管理します。
Translation
要約とは別に生成された翻訳本文です。
翻訳はまだありません。
README
取得した README 原文です。
Agents for every app.
Embed Copilot's agentic workflows in your application with the GitHub Copilot SDK for Python, TypeScript, Go, .NET, Java, and Rust.
The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-tested agent runtime you can invoke programmatically. No need to build your own orchestration—you define agent behavior, Copilot handles planning, tool invocation, file edits, and more.
| SDK | Location | Cookbook | Installation |
|---|---|---|---|
| Node.js / TypeScript | nodejs/ | Cookbook |
JSON-RPCREADMEにある具体的な導入コマンド例：
npm install @github/copilot-sdk（Node.js/TypeScript）pip install github-copilot-sdk（Python）go get github.com/github/copilot-sdk/go（Go）dotnet add package GitHub.Copilot.SDK（.NET）com.github:copilot-sdk-java（Maven/Gradleの指示はREADMEのjava/README.md参照）copilot CLIをPATHに入れるか手動でインストールする必要があります。参照: README内のインストール例、認証方式（COPILOT_GITHUB_TOKEN等）、BYOKドキュメント、およびアーキテクチャ説明。
npm install @github/copilot-sdk| Python | python/ | Cookbook | pip install github-copilot-sdk |
| Go | go/ | Cookbook | go get github.com/github/copilot-sdk/go |
| .NET | dotnet/ | Cookbook | dotnet add package GitHub.Copilot.SDK |
| Rust | rust/ | — | cargo add github-copilot-sdk |
| Java | java/ | Cookbook | Maven coordinates<br>com.github:copilot-sdk-java<br>See instructions for Maven and Gradle |
See the individual SDK READMEs for installation, usage examples, and API reference.
For a complete walkthrough, see the Getting Started Guide.
Quick steps:
For Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically and no separate installation is required.
For Go, Java, and Rust, install the CLI manually or ensure copilot is available in your PATH. Go and Rust also expose application-level CLI bundling features.
Install your preferred SDK using the commands above.
See the SDK README for usage examples and API documentation.
All SDKs communicate with the Copilot CLI server via JSON-RPC:
Your Application
↓
SDK Client
↓ JSON-RPC
Copilot CLI (server mode)
The SDK manages the CLI process lifecycle automatically. You can also connect to an external CLI server—see the Getting Started Guide for details on running the CLI in server mode.
Yes, a GitHub Copilot subscription is required to use the GitHub Copilot SDK, unless you are using BYOK (Bring Your Own Key). With BYOK, you can use the SDK without GitHub authentication by configuring your own API keys from supported LLM providers. For standard usage (non-BYOK), refer to the GitHub Copilot pricing page, which includes a free tier with limited usage.
Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI, with each prompt being counted towards your premium request quota. For more information on premium requests, see Requests in GitHub Copilot.
Yes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Azure AI Foundry, Anthropic) to access models through those providers. See the BYOK documentation for setup instructions and examples.
Note: BYOK uses key-based authentication only. Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported.
The SDK supports multiple authentication methods:
copilot CLI loginCOPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKENSee the Authentication documentation for details on each method.
No — for Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically as a dependency. You do not need to install it separately.
For Go, Java, and Rust SDKs, the CLI is not bundled by default. Install the CLI manually or ensure copilot is available in your PATH. Go and Rust also expose application-level CLI bundling features.
Advanced: You can override the CLI binary or connect to an external server. See the individual SDK README for language-specific options.
By default, the SDK exposes the Copilot CLI's first-party tools, similar to running the CLI with --allow-all. Tool execution is still governed by each SDK's permission handler, so applications can approve, deny, or customize tool calls. You can customize tool availability by configuring the SDK client options to enable and disable specific tools. Refer to the individual SDK documentation for details on tool configuration and to the Copilot CLI documentation for the list of available tools.
Yes, the GitHub Copilot SDK allows you to define custom agents, skills, and tools. You can extend the functionality of the agents by implementing your own logic and integrating additional tools as needed. Refer to the SDK documentation of your preferred language for more details.
Yes, check out the custom instructions and SDK-specific guidance:
All models available via Copilot CLI are supported in the SDK. The SDK also exposes a method which will return the models available so they can be accessed at runtime.
The GitHub Copilot SDK is generally available and follows semantic versioning. See CHANGELOG.md for release notes.
Please use the GitHub Issues page to report bugs or request new features. We welcome your feedback to help improve the SDK.
⚠️ Disclaimer: These are unofficial, community-driven SDKs and they are not supported by GitHub. Use at your own risk.
| SDK | Location |
|---|---|
| Clojure | copilot-community-sdk/copilot-sdk-clojure |
| C++ | 0xeb/copilot-sdk-cpp |
See CONTRIBUTING.md for contribution guidelines.
MIT