# セットアップ ガイド

これらのガイドでは、個人側のプロジェクトから数千人のユーザーにサービスを提供する運用プラットフォームまで、特定のユース ケースに合わせて Copilot SDK を構成する手順について説明します。

<!-- markdownlint-disable GHD046 GHD005 -->

<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -->

## アーキテクチャの概要

すべてのCopilot SDK 統合は、同じコア パターンに従います。アプリケーションは SDK と通信し、JSON-RPC 経由で Copilot CLI と通信します。 セットアップ間の変更点は、 **CLI の実行場所**、 **ユーザーの認証方法**、 **およびセッションの管理方法です**。

![図: 説明されたプロセスを示すフローチャート。](/assets/images/help/copilot/copilot-sdk/setup-choosing-a-setup-path-diagram-0.png)

以下のセットアップ ガイドは、シナリオに合わせて各レイヤーを構成するのに役立ちます。

## あなたは誰ですか。

### 🧑‍💻 愛好家

パーソナル アシスタント、サイド プロジェクト、または試験的なアプリを構築しています。 コードでCopilotを取得するための最も簡単なパスが必要です。

**最初に次の内容を使用します。**

1. \*\*
   [既定のセットアップ (バンドルされた CLI)](/ja/copilot/how-tos/copilot-sdk/setup/bundled-cli)\*\* -SDK には CLI が自動的に含まれています。インストールして実行するだけです
2. \*\*
   [ローカル CLI のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/local-cli)\*\* - 独自の CLI バイナリまたは実行中のインスタンスを使用する (詳細)

### 🏢 内部アプリ開発者

あなたはチームや会社のためのツールを構築しているところです。 ユーザーは、エンタープライズ GitHub アカウントまたは組織メンバーシップで認証する必要がある従業員です。

**最初に次の内容を使用します。**

1. \*\*
   [GitHub OAuth のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/github-oauth)\*\* - 従業員が自分のGitHub アカウントでサインインできるようにします
2. \*\*
   [バックエンド サービスのセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/backend-services)\*\* - 内部サービスで SDK を実行する

**1 台のサーバーを超えてスケーリングする場合:**

1. \*\*
   [マルチテナントとサーバーの展開](/ja/copilot/how-tos/copilot-sdk/setup/multi-tenancy)\*\* - マルチユーザー サーバー モードの SDK オプションを構成する
2. \*\*
   [スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling)\*\* - 複数のユーザーとサービスを処理する

### 🚀 アプリ開発者 (ISV)

顧客向けの製品を構築しています。 GitHubまたは ID を自分で管理することで、ユーザーの認証を処理する必要があります。

**最初に次の内容を使用します。**

1. \*\*
   [GitHub OAuth のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/github-oauth)\*\* — 顧客が GitHub でサインインできるようにします
2. \*\*
   [BYOK (独自のキーを持ち込む)](/ja/copilot/how-tos/copilot-sdk/auth/byok)\*\* - 独自のモデル キーを使用して ID を自分で管理する
3. \*\*
   [バックエンド サービスのセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/backend-services)\*\* - サーバー側コードから製品に電力を供給する

**プロダクション環境の場合:**

1. \*\*
   [マルチテナントとサーバーの展開](/ja/copilot/how-tos/copilot-sdk/setup/multi-tenancy)\*\* - `mode: "empty"`、セッションごとのトークン、分離ランタイムの状態を使用する
2. \*\*
   [スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling)\*\* - 多くのお客様に確実にサービスを提供する

### 🏗️ プラットフォーム開発者

Copilot をプラットフォーム (API、開発者ツール、または他の開発者が構築するインフラストラクチャ) に埋め込んでいます。 セッション、スケーリング、マルチテナントをきめ細かく制御する必要があります。

**最初に次の内容を使用します。**

1. \*\*
   [バックエンド サービスのセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/backend-services)\*\* - コア サーバー側の統合
2. \*\*
   [マルチテナントとサーバーの展開](/ja/copilot/how-tos/copilot-sdk/setup/multi-tenancy)\*\* - SDK レベルの分離、セッションごとの認証、および共有ランタイム オプション
3. \*\*
   [スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling)\*\* - セッションの分離、水平スケーリング、永続化

**認証モデルに応じて、次の手順を実行します。**

1. \*\*
   [GitHub OAuth のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/github-oauth)\*\*— GitHub認証されたユーザーの場合
2. \*\*
   [BYOK (独自のキーを持ち込む)](/ja/copilot/how-tos/copilot-sdk/auth/byok)\*\* - 自己管理 ID とモデル アクセス用

## デシジョン マトリックス

次の表を使用して、実行する必要がある内容に基づいて適切なガイドを見つけます。

| 必要なもの                                                                                     | ガイド |
| ----------------------------------------------------------------------------------------- | --- |
| すぐに始める                                                                                    |     |
| [既定のセットアップ (バンドルされた CLI)](/ja/copilot/how-tos/copilot-sdk/setup/bundled-cli)              |     |
| 独自の CLI バイナリまたはサーバーを使用する                                                                  |     |
| [ローカル CLI のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/local-cli)                       |     |
| ユーザーがGitHubでサインインする                                                                       |     |
| [GitHub OAuth のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/github-oauth)                |     |
| 独自のモデル キー (OpenAI、Azure など) を使用する                                                         |     |
| [BYOK (独自のキーを持ち込む)](/ja/copilot/how-tos/copilot-sdk/auth/byok)                            |     |
| マネージド ID を使用した Azure BYOK (API キーなし)                                                      |     |
| [BYOK を使用した Azure マネージド ID](/ja/copilot/how-tos/copilot-sdk/setup/azure-managed-identity) |     |
| サーバーで SDK を実行する                                                                           |     |
| [バックエンド サービスのセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/backend-services)              |     |
| 同時実行ユーザーの SDK オプションを構成する                                                                  |     |
| [マルチテナントとサーバーの展開](/ja/copilot/how-tos/copilot-sdk/setup/multi-tenancy)                    |     |
| 複数のユーザーにサービスを提供する/水平方向にスケーリングする                                                           |     |
| [スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling)                           |     |

## 構成の比較

![図: 説明されたプロセスを示すフローチャート。](/assets/images/help/copilot/copilot-sdk/setup-choosing-a-setup-path-diagram-1.png)

## Prerequisites

すべてのガイドでは、次のことを前提としています。

* **インストールされている SDK の 1 つ** (Node.js、Python、.NET SDK には CLI が自動的に含まれます)。
  * Node.js: `npm install @github/copilot-sdk`
  * パイソン: `pip install github-copilot-sdk`
  * Go: `go get github.com/github/copilot-sdk/go` (個別の CLI インストールが必要)
  * .NET：`dotnet add package GitHub.Copilot.SDK`

まったく新しい場合は、最初に **[初めてのCopilot搭載アプリを構築する](/ja/copilot/how-tos/copilot-sdk/getting-started)** から始めてから、運用環境の構成のためにここに戻ります。

## 次のステップ

上記の [決定マトリックス](#decision-matrix) から状況に一致するガイドを選択するか、ロールに最も近いペルソナの説明から始めます。