github/copilot-sdk

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

GitHub Copilot SDKs

GitHub Copilot SDKを使用すると、Copilot CLIを動かすのと同じエージェントエンジンを独自のアプリケーションに直接埋め込むことができます。Python、TypeScript/Node.js、Go、.NET、Java、Rust向けの公式パッケージが提供されています。SDKは、Copilot CLIをサーバーモードで起動し、JSON-RPCで通信し、プランニング、ツール呼び出し、ファイル編集、カスタムエージェント、スキルなどの高レベルなメソッドを公開する処理を担うため、オーケストレーションを自分で構築する必要はありません。

提供される機能

  • 6言語にわたる統一API – 各SDKはCopilot CLIの機能をミラーリングしています。
  • 自動CLI管理(Node、Python、.NETに同梱、Go、Java、Rustではオプション)。
  • エージェントランタイム – プランニング、ツール呼び出し、ファイル変更を実行します。
  • カスタムエージェント / スキル / ツール – 独自のロジックで組み込み機能を拡張できます。
  • 認証オプション – GitHubサインインユーザー、OAuthアプリ、環境変数トークン、またはBYOK(OpenAI、Anthropicなどの独自APIキー)。
  • 本番環境対応 – GAリリース、セマンティックバージョニング、チェンジログ。

クイックスタート(任意の言語)

  1. (オプション)Copilot CLIをインストール – Go、Java、Rustの場合のみ必須(自分でバンドルしない限り)。
  2. 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: MavenまたはGradleでcom.github:copilot-sdk-javaを追加。
  3. 言語固有のREADMEを読む – 使用例とAPIリファレンスを参照。
  4. コードを実行 – SDKがCopilot CLIプロセスを起動し、JSON-RPCで通信し、エージェントをプログラム的に呼び出します。

詳細情報

  • 入門ガイド – docs/getting-started.md
  • ドキュメント索引 – docs/README.md
  • クックブック – 全言語の一般的なタスクの実践的なレシピ。
  • 認証ドキュメント – docs/auth/README.md
  • 機能ガイド – docs/features/README.md

ライセンスと貢献

  • MITライセンスの下でオープンソース。
  • 標準のGitHubプルリクエストワークフロー(CONTRIBUTING.md参照)で貢献を歓迎します。

上記の情報はすべてリポジトリのREADMEから直接取得しています。

関連

  • プロジェクト
  • プロジェクト
  • Dispatch
  • プロジェクト
  • プロジェクト