Summary

This project offers a multi-platform SDK designed to integrate GitHub Copilot's agentic workflows directly into applications and services. It targets developers seeking to embed AI-powered capabilities like planning, tool invocation, and file manipulation, providing a production-tested agent runtime that abstracts away complex orchestration, thereby accelerating development.

How It Works

The SDKs, available for Python, TypeScript, Go, and .NET, function as clients that communicate with the Copilot CLI running in server mode via JSON-RPC. The SDK automatically manages the CLI process lifecycle, allowing developers to define agent behaviors while the Copilot engine handles intricate tasks such as planning, tool execution, and file edits. This approach leverages the robust Copilot CLI engine without requiring developers to build their own orchestration layers.

Quick Start & Requirements

• Installation:
  • Python: pip install github-copilot-sdk
  • Node.js/TypeScript: npm install @github/copilot-sdk
  • Go: go get github.com/github/copilot-sdk/go
  • .NET: dotnet add package GitHub.Copilot.SDK
• Prerequisites: A GitHub Copilot subscription is required. The Copilot CLI must be installed separately and available in the system's PATH.
• Resources:
  • Getting Started Guide: [Link not provided in README, but mentioned]
  • Cookbook: [Link not provided in README, but mentioned]

Highlighted Details

• Supports BYOK (Bring Your Own Key), allowing configuration with API keys from supported LLM providers like OpenAI, Azure, and Anthropic.
• Enables the definition and integration of custom agents, skills, and tools to extend core functionality.
• By default, operates with all first-party tools enabled (equivalent to copilot --allow-all), permitting file system, Git, and web operations.

Maintenance & Community

• Issues and feature requests should be reported via the GitHub Issues page.
• Contribution guidelines are available in CONTRIBUTING.md.
• Community-maintained SDKs exist for Java, Rust, C++, and Clojure.

Licensing & Compatibility

• License: MIT.
• Compatibility: The MIT license permits commercial use and integration within closed-source applications.

Limitations & Caveats

The GitHub Copilot SDK is currently in Technical Preview and may not be suitable for production environments. A separate installation of the Copilot CLI is a mandatory prerequisite for SDK functionality.