はじめに

このガイドでは、ローカル開発環境のセットアップとチュートリアルスクリプトの実行に必要なすべての手順を説明します。

前提条件

要件	最低バージョン	用途
Python	3.13+	ランタイム
uv	最新版	パッケージ管理
Node.js（`npm`）または GitHub CLI（`gh`）	最新版	Copilot CLI のインストール
GitHub Copilot サブスクリプション	—	API アクセスに必要

インストール

SDK とチュートリアルの依存関係をインストール

チュートリアルスクリプトで使用するすべてのパッケージ（github-copilot-sdk、pydantic、azure-identity など）は src/python/pyproject.toml に宣言されています。uv sync コマンド一つでまとめてインストールできます。

cd src/python
uv sync --all-groups

uv sync は .venv/ に仮想環境を作成し、uv.lock に固定された依存関係をすべてインストールします。仮想環境を手動でアクティブ化する代わりに uv run <command> を使うと、その環境内でツールを実行できます。

GitHub 認証

Copilot CLI は Copilot アクセス権を持つ GitHub アカウントが必要です。

オプション A: GitHub CLI 認証（推奨）

gh auth login
# Copilot CLI は gh CLI の認証情報を自動的に利用します。

オプション B: パーソナルアクセストークン（PAT）

GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic) に移動
copilot スコープ（または read:user + Copilot 有効な org）でトークンを生成
エクスポート:

export COPILOT_GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxx"

Copilot CLI のインストール

SDK は copilot CLI を stdio 経由のサブプロセスとして起動します。このためバイナリがマシン上で利用可能である必要があります。次のいずれかでインストールしてください。

# オプション A: npm（`copilot` コマンドを PATH にインストール）
npm install -g @github/copilot

# オプション B: gh copilot（バイナリをダウンロード・管理）
gh copilot   # 初回実行時に ~/.local/share/gh/copilot に CLI をダウンロード

実行可能か確認:

copilot --version
# または gh copilot でインストールした場合:
gh copilot -- --version

ヒント: copilot が PATH 上にない場合は、SDK にバイナリの場所を伝えます:
export COPILOT_CLI_PATH="/absolute/path/to/copilot"

チュートリアルスクリプトは独立した Copilot CLI サーバーを起動する必要はありません — SDK が stdio 経由でオンデマンドに起動します。既に TCP モードで動く Copilot CLI がある場合は、オプションとして --cli-url host:port フラグを使えます。起動方法は後述の 「Copilot CLI をサーバーモードで起動する」 を参照してください。

Copilot CLI の更新

CLI は npm パッケージ @github/copilot として配布されています。最新の SDK 互換機能や修正を取り込むため、常に最新の状態に保ちましょう。

# 最新バージョンに更新
npm install -g @github/copilot@latest

# 特定のバージョンに固定（@latest を @<version> に置き換える）
npm install -g @github/copilot@0.0.339

便利な確認コマンド:

copilot --version                          # インストール済みのバージョンを表示
npm view @github/copilot versions --json   # 利用可能なバージョン一覧を表示

ヒント: CLI の実行中は /update スラッシュコマンドでも更新を確認・適用できます。

Copilot CLI をサーバーモードで起動する（任意）

フラグごとの詳細説明、ログレベル、パーミッションの限定、COPILOT_CONNECTION_TOKEN によるサーバーの保護、Docker デプロイまでを網羅した完全なリファレンスは CLI サーバーモードを参照してください。

デフォルトでは SDK が copilot CLI を stdio 経由で自動起動するため、手動で何かを起動する必要はありません。CLI を長時間稼働する TCP サーバー として一度だけ起動し、各スクリプトからそこへ接続したい場合は、サーバーモードで起動します。

# 先に認証しておく（上記「GitHub 認証」を参照）
export COPILOT_GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxx"

# Copilot CLI をポート 3000 の TCP サーバーとして起動
copilot \
  --server \
  --port 3000 \
  --log-level all \
  --allow-all-tools --allow-all-paths --allow-all-urls \
  --model gpt-5-mini

リポジトリ内では、同じコマンドが Make ターゲットとして用意されています。

cd src/python
export COPILOT_GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxx"
make copilot           # `copilot --server --port 3000 ...` を実行

フラグ	用途
`--server`	対話セッションではなく長時間稼働のサーバーとして CLI を起動
`--port 3000`	サーバーが待ち受ける TCP ポート
`--log-level all`	詳細ログ（学習中に便利）
`--allow-all-tools` / `--allow-all-paths` / `--allow-all-urls`	ツール・ファイル・ネットワークアクセスを事前承認し、無人で動作させる
`--model gpt-5-mini`	サーバーが使用するデフォルトモデル（`COPILOT_MODEL` で変更可能）

その後、--cli-url で任意のチュートリアルスクリプトを起動中のサーバーに接続します。

# 別のターミナルで
cd src/python
uv run python scripts/tutorials/01_chat_bot.py \
  --prompt "What is GitHub Copilot?" \
  --cli-url localhost:3000

注意: --allow-all-* は対話的なパーミッション確認を無効化します。ローカルでの実験用途のみに使用し、信頼できないネットワークにこのサーバーを公開しないでください。

最初のスクリプトを実行する

チュートリアルスクリプトは src/python ディレクトリから uv run python で実行すると、管理された仮想環境内で動作します。

cd src/python
uv run python scripts/tutorials/01_chat_bot.py --prompt "What is GitHub Copilot?"

期待される出力（ストリーミング）:

GitHub Copilot is an AI-powered coding assistant developed by GitHub and OpenAI...

プロジェクト構成

src/python/scripts/tutorials/
├── README.md                   # スクリプト一覧と実行手順
├── 01_chat_bot.py              # チュートリアル 1: CLI チャットボット
├── 02_issue_triage.py          # チュートリアル 2: カスタムツールによる Issue トリアージ
├── 03_streaming_review.py      # チュートリアル 3: ストリーミングコードレビュー
├── 04_skills_docgen.py         # チュートリアル 4: スキルによるドキュメント生成
├── 05_audit_hooks.py           # チュートリアル 5: セッションフックによる監査ログ
├── 06_byok_azure_openai.py     # チュートリアル 6: Azure OpenAI を使った BYOK
└── skills/
    ├── docgen/SKILL.md
    └── coding-standards/SKILL.md

環境変数

すべてのチュートリアルスクリプトは --cli-url（デフォルト: stdio）を受け付けます。スクリプト 06 は環境変数から BYOK 設定も読み込みます。

変数名	用途	使用するスクリプト
`COPILOT_GITHUB_TOKEN`	Copilot CLI 用の GitHub PAT（`gh auth login` の代替）	Copilot CLI サブプロセス
`COPILOT_CLI_PATH`	`copilot` バイナリの絶対パス（PATH にない場合）	SDK のサブプロセスランチャー
`BYOK_BASE_URL`	Azure OpenAI デプロイのベース URL	スクリプト 06
`BYOK_API_KEY`	Azure OpenAI API キー	スクリプト 06（api-key 認証）
`BYOK_MODEL`	モデル/デプロイ名	スクリプト 06

次のステップ

環境の準備ができたら、チュートリアルを順番に進めてください:

CLI チャットボット — Copilot を使った最初のスクリプトを作成
カスタムツール — 独自のツールでエージェントを拡張
ストリーミング — リアルタイムでトークンを受信
スキル — SKILL.md で再利用可能なエージェント動作を定義
フックとパーミッション — すべてのアクションを観察・制御
BYOK — Azure OpenAI を LLM バックエンドとして利用