github/copilot-sdk được TopGit xếp vào nhóm dự án mã nguồn mở, với 10.7k sao trên GitHub, viết chủ yếu bằng Java. Multi-platform SDK for integrating GitHub Copilot Agent into apps and services
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
[!IMPORTANT]
GitHub Copilot SDK is becoming Microsoft Copilot SDK, the programmable interface for the Microsoft Copilot harness, the shared agent foundation used across Microsoft and GitHub products.
The SDK repository will move to the Microsoft organization as part of a phased transition. Existing package names, namespaces, and some documentation may continue to reference GitHub Copilot SDK during the transition. No immediate changes are required for existing users. Learn more about the transition.
Support for the Copilot SDK remains the same. For more information: SUPPORT.md
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.
Available SDKs
SDK
Location
Cookbook
Installation
API docs
Node.js / TypeScript
nodejs/
Cookbook
npm install @github/copilot-sdk
Python
python/
Cookbook
pip install github-copilot-sdk
Go
go/
Cookbook
go get github.com/github/copilot-sdk/go
API docs
.NET
dotnet/
Cookbook
dotnet add package GitHub.Copilot.SDK
Rust
rust/
—
cargo add github-copilot-sdk
API docs
Java
java/
Cookbook
Maven coordinates com.github:copilot-sdk-java See instructions for Maven and Gradle
API docs
See the individual SDK READMEs for installation, usage examples, and API reference.
Getting Started
For a complete walkthrough, see the Getting Started Guide.
Quick steps:
(Optional) Install the Copilot CLI
The Node.js and .NET SDKs include the Copilot CLI as a dependency, so no separate installation is required. The Python SDK downloads it automatically on first use, or ahead of time with python -m copilot download-runtime.
The Rust SDK bundles the CLI by default through its bundled-cli feature.
For Go, embed the CLI with the bundler tool; for Java, add the com.github:copilot-sdk-java-runtime dependency with your platform's classifier. Alternatively, install the CLI manually and give the SDK its path with COPILOT_CLI_PATH or the client's CLI path option. The SDKs do not look up copilot on your PATH.
Install your preferred SDK using the commands above.
See the SDK README for usage examples and API documentation.
Architecture
All SDKs drive the Copilot agent runtime over JSON-RPC. By default the runtime is hosted by the Copilot CLI running as a child process in 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.
Every SDK also offers an experimental in-process transport. It loads the native Copilot runtime into your application through a C ABI and carries the same JSON-RPC messages over an in-memory connection, so no CLI process is started:
Your Application
↓
SDK Client
↓ JSON-RPC (in memory, C ABI)
Native Copilot runtime
See Run the Copilot runtime in process for the connection option in each language and its requirements.
Portable elicitation schemas
For form elicitation callbacks, the portable schema contract is an object form
with modeled properties and optional required fields (type: "object" on
the wire; an SDK may represent the object type implicitly). Applications that
support multiple SDK languages must use the modeled property definitions and
must not depend on additional schema metadata (such as a top-level title) or
on the insertion order of properties.
Node.js and Rust pass through the wire schema, including additional metadata
and property order. Python, Go, .NET, and Java reconstruct the callback schema
from the modeled fields and do not offer that same preservation guarantee.
Treat wire-schema preservation as a language-specific capability, not a
cross-language requirement.
Agent Finder Skill installation APIs
Runtimes that grant skill-confirmed-installation expose
skills.planInstall, skills.applyInstall, skills.planUninstall,
skills.applyUninstall, skills.installations.list/recover/status/cancel,
and skills.installations.setEnabled. Skill install reviews include the full
verified SKILL.md content up to 256 KiB, catalogue identity, file manifest,
and non-absolute personal target location. Summaries report ownershipState,
configuredEnabled, sessionState, retained catalogue identity and
installedAt.
FAQ
Do I need a GitHub Copilot subscription to use the SDK?
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.
How does billing work for SDK usage?
Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI, with each prompt being counted towards your usage allowance. For more information on Copilot usage billing, see Usage in GitHub Copilot.
Does it support BYOK (Bring Your Own Key)?
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, Microsoft 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.
What authentication methods are supported?
The SDK supports multiple authentication methods:
GitHub signed-in user - Uses stored OAuth credentials from copilot CLI login
OAuth GitHub App - Pass user tokens from your GitHub OAuth app
BYOK - Use your own API keys (no GitHub auth required)
See the Authentication documentation for details on each method.
Do I need to install the Copilot CLI separately?
No — the Node.js and .NET SDKs include the Copilot CLI as a dependency, and the Python SDK downloads it automatically on first use (run python -m copilot download-runtime to fetch it ahead of time). You do not need to install it separately.
The Rust SDK bundles the CLI by default through its bundled-cli feature.
For Go and Java SDKs, the CLI is not bundled by default. Go embeds it with its bundler tool, and Java uses the com.github:copilot-sdk-java-runtime dependency with your platform's classifier. Otherwise, install the CLI manually and give the SDK its path with COPILOT_CLI_PATH or the client's CLI path option. The SDKs do not look up copilot on your PATH.
Advanced: You can override the CLI binary or connect to an external server. See the individual SDK README for language-specific options.
What tools are enabled by default?
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.
Can I use custom agents, skills or 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.
Are there instructions or SDK guidance for Copilot to speed up development?
Yes, check out the custom instructions and SDK-specific guidance:
Node.js / TypeScript
Python
.NET
Go
Rust (SDK guidance; custom instructions not yet published)
Java
What models are supported?
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.
Is the SDK production-ready?
The GitHub Copilot SDK is generally available and follows semantic versioning. See CHANGELOG.md for release notes.
How do I report issues or request features?
Please use the GitHub Issues page to report bugs or request new features. We welcome your feedback to help improve the SDK.
Quick Links
Documentation – Full documentation index
Getting Started – Tutorial to get up and running
Setup Guides – Architecture, deployment, and scaling
Authentication – GitHub OAuth, BYOK, and more
Features – Hooks, custom agents, MCP, skills, and more
Troubleshooting – Common issues and solutions
Cookbook – Practical recipes for common tasks across all languages
More Resources – SDK instructions for C#, Go, Node.js/TypeScript, and Python, plus a skill
Unofficial, Community-maintained SDKs
⚠️ Disclaimer: These are unofficial, community-driven SDKs and they are not supported by GitHub. Use at your own risk.
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/github/copilot-sdk là nguồn chính thức.
github/copilot-sdk có bao nhiêu sao?
github/copilot-sdk có 10.7k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/github/copilot-sdk. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
github/copilot-sdk có phải mã nguồn mở không?
Có — github/copilot-sdk phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/github/copilot-sdk.
github/copilot-sdk còn đang phát triển không?
Commit gần nhất trên github/copilot-sdk là 6 ngày trước (theo timestamp GitHub). Repo có 1.5k fork — một chỉ báo về mức độ quan tâm của cộng đồng.
github/copilot-sdk dùng license gì?
github/copilot-sdk phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
github/copilot-sdk là gì?
github/copilot-sdk (github/copilot-sdk) là dự án Java trên GitHub. Theo mô tả gốc: Multi-platform SDK for integrating GitHub Copilot Agent into apps and services
github/copilot-sdk viết bằng ngôn ngữ gì?
github/copilot-sdk chủ yếu viết bằng Java. Trường "language" của GitHub dựa trên phần lớn byte ở nhánh mặc định.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về copilot-sdk?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về copilot-sdk.