Copilot SDK（GitHub リポジトリ）

GitHub Copilot CLI SDK

あらゆるアプリにエージェントを。

Python、TypeScript、Go、.NET、Java、Rust 向けの GitHub Copilot SDK を利用すれば、アプリケーション内に Copilot のエージェントワークフローを組み込むことができます。

GitHub Copilot SDK は、Copilot CLI の背後にあるエンジン、つまりプログラムから呼び出せる実用テスト済みのエージェントランタイムを公開しています。独自にオーケストレーションを構築する必要はありません。エージェントの振る舞いを定義するだけで、Copilot が計画立案、ツール呼び出し、ファイル編集などを担当してくれます。

利用可能な SDK

インストール方法、使用例、API リファレンスについては、各 SDK の README をご覧ください。

入門ガイド

完全な手順については、入門ガイド を参照してください。

簡単なステップ:

• (オプション) Copilot CLI のインストール

Node.js、Python、.NET SDK では、Copilot CLI は自動的にバンドルされており、別途インストールする必要はありません。Go、Java、Rust の場合は、CLI を手動でインストールするか、copilot が PATH に登録されていることを確認してください。Go と Rust では、アプリケーションレベルでの CLI バンドリング機能も提供されています。

• 上記のコマンドを使用して、お好みの SDK をインストールします。

• 使用例や API ドキュメントについては、各 SDK の README をご覧ください。

アーキテクチャ

すべての SDK は、JSON-RPC を介して Copilot CLI サーバーと通信します:

Your Application
       ↓
  SDK Client
       ↓ JSON-RPC
  Copilot CLI (server mode)

SDK は CLI プロセスのライフサイクルを自動的に管理します。外部の CLI サーバーに接続することも可能です。サーバーモードで CLI を実行する方法の詳細については、入門ガイドをご覧ください。

よくある質問 (FAQ)

SDK を利用するには GitHub Copilot のサブスクリプションが必要ですか？

GitHub Copilot SDK を利用するには、GitHub Copilotsubscription の契約が必要です。ただし、BYOK（Bring Your Own Key）を利用している場合は例外です。BYOK を使えば、サポート対象の LLM プロバイダーから API キーを自分で設定することで、GitHub への認証なしに SDK を使用できます。

標準的な利用方法（非 BYOK）については、GitHub Copilots の料金ページをご参照ください。こちらには、限定的な利用が可能な無料枠も含まれています。

SDK 利用の請求はどうなるのですか？

GitHub Copilot SDK の課金モデルは、Copilot CLI と同じ仕組みです。各プロンプトが利用枠にカウントされます。詳細については、GitHub Copilots の利用に関する情報をご覧ください。

BYOK（Bring Your Own Key）はサポートされていますか？

はい、GitHub Copilot SDK は BYOK（Bring Your Own Key）に対応しています。SDK を設定して、OpenAI や Azure AI Foundry、Anthropic などのサポート対象 LLM プロバイダーから取得した API キーを使用することで、これらのプロバイダー経由でモデルにアクセスできます。

セットアップ手順やサンプルについては、BYOK のドキュメントをご参照ください。

注意: BYOK ではキーベースの認証のみが利用可能です。Microsoft Entra ID（Azure AD）、マネージドアイデンティティ、サードパーティのアイデンティティプロバイダーはサポートされていません。

どのような認証方式がサポートされていますか？

SDK は複数の認証方式をサポートしています：

• GitHub にサインインしたユーザー: copilot コマンドラインツールでログインした際に保存された OAuth クレデンシャルを使用します。

• OAuth GitHub アプリ: ユーザーのトークンを、ご自身の GitHub OAuth アプリから渡すことができます。

• 環境変数: COPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKEN

• BYOK - 独自の API キーを使用する（GitHub の認証は不要）

各方法の詳細については、認証ドキュメント をご覧ください。

Copilot CLI は別途インストールする必要がありますか？

Node.js、Python、.NET の各 SDK では、Copilot CLI は依存関係として自動的にバンドルされます。別途インストールする必要はありません。

一方、Go、Java、Rust の SDK では、CLI はデフォルトでバンドルされません。手動で CLI をインストールするか、PATH に copilot が追加されていることを確認してください。Go と Rust では、アプリケーションレベルでの CLI バンドリング機能も提供されています。

上級者向け：CLI のバイナリを置き換えたり、外部サーバーに接続したりすることも可能です。言語固有のオプションについては、各 SDK の README を参照してください。

デフォルトで有効になっているツールは？

デフォルトでは、SDK は Copilot CLI のファーストパーティ製ツールを公開します。これは --allow-all オプションで CLI を実行した場合と同様の挙動です。ただしツールの実行は各 SDK の権限ハンドラによって制御されるため、アプリケーション側で呼び出しの承認や拒否、カスタマイズが可能です。

特定のツールの利用可否を切り替えるには、SDK クライアントの設定オプションを変更して有効化・無効化を行います。ツール設定の詳細については各 SDK のドキュメントを、利用可能なツールの一覧については Copilot CLI のドキュメントをご参照ください。

カスタムエージェントやスキル、ツールを利用できますか？

はい、GitHub Copilot SDK を使えば独自のエージェント、スキル、ツールを定義できます。必要に応じて独自のロジックを実装したり追加のツールを統合したりすることで、エージェントの機能を拡張可能です。詳細はご使用の言語に対応する SDK ドキュメントをご覧ください。

開発を加速するための指示や SDK ガイドラインはありますか？

はい、カスタムインストラクションと各 SDK 固有のガイドラインがありますのでご確認ください：

• Node.js / TypeScript

• Python

• .NET

• Go

対応言語

• Rust (SDK のガイドライン；カスタム指示はまだ公開されていません)
• Java

対応モデルは？

Copilot CLI で利用可能なすべてのモデルを SDK でもサポートしています。また、SDK には実行時に利用可能なモデル一覧を取得するメソッドも用意されています。

SDK は本番環境で使えますか？

GitHub Copilot SDK は一般提供されており、セマンティックバージョニングに従っています。リリースノートについては CHANGELOG.md をご確認ください。

不具合報告や機能要望はどうすればいいですか？

バグの報告や新機能のリクエストは、GitHub Issues ページをご利用ください。SDK の改善のために、皆様からのフィードバックを歓迎しています。

よく使うリンク

• ドキュメント – 完全なドキュメントインデックス
• 入門ガイド – すぐに使い始めるためのチュートリアル
• セットアップガイド – アーキテクチャ、デプロイメント、スケーリングについて
• 認証 – GitHub OAuth、BYOK など

• Features – フック、カスタムエージェント、MCP、スキルなど
• Troubleshooting – よくある問題と解決策
• Cookbook – 全言語で使える実用的なレシピ集
• More Resources – その他のサンプル、チュートリアル、コミュニティリソース

非公式・コミュニティ主導の SDK

⚠️ 免責事項：これらは GitHub が公式にサポートしていない、コミュニティが主導する非公式の SDK です。利用は自己責任で行ってください。

貢献について

貢献ガイドラインは CONTRIBUTING.md をご覧ください。

ライセンス

MIT