コンテンツにスキップ

GitHub Copilot SDK チュートリアル

GitHub Copilot SDK を使って実際のアプリケーションを構築するためのステップバイステップガイドです。Python 版と Go 版の両方を提供しています。

このページでは、すべての版に共通する言語非依存の概念（SDK とは何か、どのように動作するか、Copilot CLI のセットアップ方法）を扱います。SDK 固有の API・コード・実行手順は、下記から言語を選択してください。

GitHub Copilot SDK とは？

GitHub Copilot SDK は、GitHub Copilot CLI を動かすのと同じエージェントランタイムへのプログラマブルなインタフェースです。LLM 推論、ツール呼び出し、ストリーミング、スキル実行など Copilot の機能を独自のプログラムに直接組み込むことができます。

graph TD
    A[Your Program] -->|SDK Client| B[Copilot Client]
    B -->|JSON-RPC over stdio| C[Copilot CLI Server]
    C -->|API Call| D[GitHub Copilot API]
    C -->|Tool Execution| E[Built-in Tools]
    C -->|Custom Tool| F[User-defined Tools]
    C -->|Skills| G[SKILL.md Files]

    style A fill:#e1f5fe
    style B fill:#bbdefb
    style C fill:#90caf9
    style D fill:#64b5f6

SDK であるもの

  • Copilot を独自コードに統合するためのライブラリ（Python は github-copilot-sdk、Go は github.com/github/copilot-sdk/go）
  • セッション作成、プロンプト送信、レスポンス受信をプログラマブルに行う手段
  • カスタムツール、スキル（SKILL.md）、ストリーミング、BYOK のサポート
  • Copilot CLI が使うのと同じランタイム — 再利用可能な API として公開

SDK でないもの

  • Copilot Chat UI や GitHub.com の Copilot インタフェースの代替品
  • 独自モデルのファインチューニングやホスティング手段
  • 汎用的な OpenAI 互換 HTTP クライアント
  • REST API や Web アプリケーションを構築するためのフレームワーク

コンポーネントとリクエストフローの詳細は アーキテクチャ を参照してください。

言語を選択する

チュートリアルは両版でミラーリングされており、各レシピが 1 対 1 で対応するため、同じタスクをどちらの言語でも比較できます。

版 ここから始める チュートリアル
Python Python はじめに Python チュートリアル — チャットボット、カスタムツール、ストリーミング、スキル、フック、BYOK
Go Go はじめに Go チュートリアル — CLI チャットボット、ストリーミング、インタラクティブセッション

SDK が初めてですか？ まずは下記の共通セットアップを済ませてから、お好みの版に進んでください。

共通セットアップ

どの版も、同じ Copilot CLI バイナリと GitHub 認証を使用します。はじめに で次の共通手順を一度だけ完了してください。

  1. Copilot CLI のインストール
  2. GitHub で認証する

その後、SDK のインストールとチュートリアルの実行については各言語版の「はじめに」に従ってください。

共通セットアップの完全なガイドは はじめに を参照してください。

スコープ

含めるもの:

  • GitHub Copilot SDK の概念説明（何であるか／何でないか）
  • アーキテクチャと動作原理
  • 言語ごとの SDK API 設計、サンプルコード、ステップバイステップガイド
  • カスタムツール、スキル、セッションフック、パーミッションハンドリング、ストリーミング、BYOK

含めないもの:

  • TypeScript / .NET SDK の詳細（参考文献 を参照）
  • Copilot CLI 単体の使い方ガイド
  • 本番運用・スケーリング・インフラ構築の詳細
  • GitHub OAuth App 認証フロー（CopilotReportForge ドキュメント を参照）

さらに読む

ドキュメント 説明
はじめに 共通セットアップ: Copilot CLI のインストールと認証
アーキテクチャ SDK、CLI サーバー、Copilot API の相互作用
CLI サーバーモード Copilot CLI を単独 TCP サーバーとして起動する
Python チュートリアル Python 版
Go チュートリアル Go 版
参考文献 API リファレンスと外部リンク