github/copilot-sdk

Multi-platform SDK for integrating GitHub Copilot Agent into apps and services

GitHub Copilot SDKs

GitHub Copilot SDKs let you embed the same agentic engine that powers the Copilot CLI directly inside your own applications. Official packages are provided for Python, TypeScript/Node.js, Go, .NET, Java, and Rust. The SDKs handle launching the Copilot CLI in server mode, communicating over JSON‑RPC, and exposing high‑level methods for planning, tool invocation, file edits, custom agents, skills, and more – so you don’t have to build the orchestration yourself.

What you get

  • Unified API across six languages – each SDK mirrors the Copilot CLI capabilities.
  • Automatic CLI management (bundled for Node, Python, .NET; optional for Go, Java, Rust).
  • Agent runtime that performs planning, tool calls, and file modifications.
  • Custom agents / skills / tools – extend the built‑in functionality with your own logic.
  • Authentication options – GitHub‑signed‑in user, OAuth app, environment‑variable tokens, or BYOK (your own API keys for OpenAI, Anthropic, etc.).
  • Production‑ready – GA release, semantic versioning, and a changelog.

Quick start (any language)

  1. (Optional) Install the Copilot CLI – required only for Go, Java, and Rust unless you bundle it yourself.
  2. Install the SDK
    • Node: npm install @github/copilot-sdk
    • Python: pip install github-copilot-sdk
    • Go: go get github.com/github/copilot-sdk/go
    • .NET: dotnet add package GitHub.Copilot.SDK
    • Rust: cargo add github-copilot-sdk
    • Java: add com.github:copilot-sdk-java via Maven or Gradle.
  3. Read the language‑specific README for usage examples and API reference.
  4. Run your code – the SDK will start the Copilot CLI process, talk to it via JSON‑RPC, and let you invoke agents programmatically.

Where to learn more

  • Getting‑started guide – docs/getting‑started.md
  • Full documentation index – docs/README.md
  • Cookbook – practical recipes for common tasks across all languages.
  • Authentication docs – docs/auth/README.md
  • Feature guide – docs/features/README.md

License & contribution

  • Open‑source under the MIT license.
  • Contributions are welcomed via the standard GitHub pull‑request workflow (see CONTRIBUTING.md).

All information above is taken directly from the repository’s README.

Related

  • Project
    github/app

    The GitHub Copilot app is a desktop client that lets you run Copilot‑powered AI agents in isolated git worktrees or cloud environments, manage issues/PRs across repos, and automate prompts. It provides visual “canvases” for agent output, parallel sessions, and an “Agent Merge” flow to auto‑merge PRs after checks. Installable on Windows, macOS, and Linux; requires a Copilot plan or your own model key.

  • Project
    caozhiyuan/copilot-api

    Copilot API is an open‑source Node/Bun server that provides a single local OpenAI‑compatible endpoint, routing coding‑assistant requests to GitHub Copilot, built‑in Codex/xAI, or many third‑party model providers. It supports Chat Completions, Responses, and Anthropic Messages, offers streaming via SSE/WebSocket, includes a desktop Electron GUI, Docker deployment, and a CLI for quick start.

  • Dispatch
    CopilotKit Channels SDK Open-Source Release Enables Any AI Agent on Slack, Teams, Discord, and More

    CopilotKit released the open-source Channels SDK, letting developers attach any AG‑UI‑compatible AI agent to Slack, Microsoft Teams, Discord, Telegram and other chat platforms with native interactive UI.

  • Project
    github/copilot-cli

    A terminal-based AI coding agent that allows developers to build, debug, and refactor code using natural language and GitHub integration.

  • Project
    CopilotKit/CopilotKit

    An SDK for building agent-native applications that allows a single agent backend to power generative UI and shared state across web, mobile, and chat platforms.