README
¶
GitHub Copilot CLI SDKs
Agents for every app.
Embed Copilot's agentic workflows in your application—now available in Technical preview as a programmable SDK for Python, TypeScript, Go, and .NET.
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 | Installation |
|---|---|---|
| Node.js / TypeScript | cookbook/nodejs/ |
npm install @github/copilot-sdk |
| Python | cookbook/python/ |
pip install github-copilot-sdk |
| Go | cookbook/go/ |
go get github.com/github/copilot-sdk/go |
| .NET | cookbook/dotnet/ |
dotnet add package GitHub.Copilot.SDK |
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:
-
Install the Copilot CLI:
Follow the Copilot CLI installation guide to install the CLI, or ensure
copilotis available in your PATH. -
Install your preferred SDK using the commands above.
-
See the SDK README for usage examples and API documentation.
Architecture
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 individual SDK docs for details.
Quick Links
- Getting Started – Tutorial to get up and running
- Cookbook – Practical recipes for common tasks across all languages
- Samples – Video walkthroughs and sample projects
Contributing
See CONTRIBUTING.md for contribution guidelines.
License
MIT
Directories