メモ
Copilot SDK は現在 テクニカル プレビューです。 機能と可用性は変更される場合があります。
アーキテクチャの概要
すべての GitHub Copilot SDK 統合は、同じコア パターンに従います。アプリケーションは SDK と通信し、JSON-RPC 経由で Copilot CLI (コパイロット CLI) と通信します。 セットアップ間の変更点は、CLI の実行場所、ユーザーの認証方法、およびセッションの管理方法です。
ユーザーはだれか
愛好家
パーソナル アシスタント、サイド プロジェクト、または試験的なアプリを構築しています。 コードでCopilotを取得するための最も簡単なパスが必要です。
最初に次の内容を使用します。
- Copilot SDK でのローカル CLI の使用 - コンピューターに既にサインインしている CLI を使用します。
- Copilot SDK でバンドルされた CLI を使用する - すべてをスタンドアロン アプリにパッケージ化します。
内部アプリ開発者
あなたはチームや会社のためのツールを構築しているところです。 ユーザーは、エンタープライズ GitHub アカウントまたは組織メンバーシップで認証する必要がある従業員です。
最初に次の内容を使用します。
- Copilot SDK での GitHub OAuth の使用 - 従業員が自分の GitHub アカウントでサインインできるようにします。
- バックエンド サービス用の Copilot SDK の設定 - 内部サービスで SDK を実行します。
1 台のサーバーを超えてスケーリングする場合:
- Copilot SDK デプロイのスケーリング - 複数のユーザーとサービスを処理します。
アプリ開発者 (ISV)
顧客向けの製品を構築しています。 GitHubまたは ID を自分で管理することで、ユーザーの認証を処理する必要があります。
最初に次の内容を使用します。
- Copilot SDK での GitHub OAuth の使用 - 顧客が GitHubでサインインできるようにします。
-
リポジトリの
github/copilot-sdk- 独自のモデル キーを使用して ID を管理します。 - バックエンド サービス用の Copilot SDK の設定 - サーバー側コードから製品に電力を供給します。
プロダクション環境の場合:
- Copilot SDK デプロイのスケーリング - 多くのお客様に確実にサービスを提供します。
プラットフォーム開発者
Copilot をプラットフォーム (API、開発者ツール、または他の開発者が構築するインフラストラクチャ) に埋め込んでいます。 セッション、スケーリング、マルチテナントをきめ細かく制御する必要があります。
最初に次の内容を使用します。
- バックエンド サービス用の Copilot SDK の設定 - コア サーバー側統合。
- Copilot SDK デプロイのスケーリング - セッションの分離、水平スケーリング、永続化。
認証モデルに応じて次の手順を実行します。
- Copilot SDK での GitHub OAuth の使用 - GitHub認証されたユーザー向け。
-
リポジトリ内の
github/copilot-sdk-セルフマネージド ID とモデル アクセス用。
デシジョン マトリックス
この表を使用して、必要な操作に基づいて適切なガイドを見つけます。
| 必要なもの | ガイド |
|---|---|
| 最もシンプルなセットアップ | |
| Copilot SDK でのローカル CLI の使用 | |
| Copilot を使用してスタンドアロン アプリを出荷する | |
| Copilot SDK でバンドルされた CLI を使用する | |
| ユーザーは次の方法でサインインします。 GitHub | |
| Copilot SDK での GitHub OAuth の使用 | |
| 独自のモデル キー (OpenAI、Azure など) を使用する | |
| [ | |
](https://github.com/github/copilot-sdk/blob/main/docs/auth/byok.md) リポジトリの github/copilot-sdk | |
| マネージド ID を使用した Azure BYOK (API キーなし) | |
| Copilot SDK での Azure マネージド ID の使用 | |
| サーバーで SDK を実行する | |
| バックエンド サービス用の Copilot SDK の設定 | |
| 複数のユーザーにサービスを提供するか、水平方向にスケーリングする | |
| Copilot SDK デプロイのスケーリング |
前提条件
すべてのガイドでは、次のことを前提としています。
- Copilot CLI (コパイロット CLI) インストール。 詳細については、「GitHub Copilot CLI のインストール」を参照してください。
- インストールされている SDK の 1 つ:
- Node.js:
npm install @github/copilot-sdk - パイソン:
pip install github-copilot-sdk - Go:
go get github.com/github/copilot-sdk/go - .NET：
dotnet add package GitHub.Copilot.SDK - Java: Maven/Gradle セットアップ用の
github/copilot-sdk-javaリポジトリを参照してください
- Node.js:
GitHub Copilot SDKを初めて使用する場合は、最初に Copilot SDK のはじめに から始めてから、運用環境の構成のためにここに戻ります。
次のステップ
上記の 決定マトリックス から状況に一致するガイドを選択するか、ロールに最も近いペルソナの説明から始めます。