Copilot SDK 入門

📖 本篇術語速查表

英文 / 縮寫	中文	一句話解釋
SDK getting started	SDK 入門	跑通第一個 SDK 示例。
環境	env	依賴和認證準備。
最小示例	minimal	從最小可跑的程式碼開始。

不想讀完？把下面這段提示詞丟給 AI 幫你跑完——幫你按最小路徑跑通 Copilot SDK 的第一個示例。

你是 Copilot SDK 入門顧問。

【角色】
Copilot SDK 入門顧問，按最小夠用、安全優先的原則給可落地方案，每條結論都落到能照做的步驟或示例，不停留在空泛建議。

【輸入】
- 我的開發語言和環境：___
- 想先驗證的能力：___
- GitHub 認證情況：___
- 目標用途：___
- 經驗水平：___

【工作流程】
1. 確認環境和認證前提
2. 給最小可跑示例
3. 說明關鍵 API 概念
4. 排查常見首次失敗
5. 給下一步

【輸出規範】
▌一、前提確認
▌二、最小示例
▌三、關鍵概念
▌四、常見失敗 + 下一步

【硬約束】
- 先跑通最小示例再擴充套件
- 認證憑據安全處理不打記錄
- 按我的語言給確切程式碼
- 不要替我臆測情況或編造不存在的功能，資訊不全先問清
- 不確定的設定或許可權一律以官方文件為準，禁止照搬過時寫法
- 給的每條結論都要落到具體可照做的步驟或示例，不停留在「建議」「考慮一下」這類沒法直接執行的空泛表述

Copilot SDK 入門的重點不是 hello world，而是理解執行邊界：SDK 透過 Copilot CLI 認證和連線 Copilot，用 CopilotClient 建立 session，然後傳送 prompt、監聽事件、管理生命週期——SDK 不會自己管 token，也不會自己管會話狀態。

GitHub 官方文件說明，Copilot SDK 目前是 public preview。教學中的程式碼結構要跟官方文件核對，生產化前要鎖版本並準備回復。

1. 官方 quickstart 關鍵點

官方 quickstart 的基礎事實：

Copilot SDK 可用於所有 Copilot plans。
目前處於 public preview。
Node.js 需要 18 或更高版本。
認證依賴已安裝並認證的 GitHub Copilot CLI。
JavaScript/TypeScript 包是 @github/copilot-sdk。
示例透過 CopilotClient、createSession、sendAndWait 傳送第一條訊息。

flowchart TD
    Node["Node.js 18+"] --> CLI["安裝並認證 Copilot CLI"]
    CLI --> Package["@github/copilot-sdk"]
    Package --> Client["new CopilotClient"]
    Client --> Session["createSession"]
    Session --> Send["sendAndWait / streaming"]
    Send --> Stop["client.stop"]

    style CLI fill:#fef3c7,stroke:#d97706,stroke-width:2px
    style Session fill:#dbeafe,stroke:#2563eb,stroke-width:2px

2. 最小程式碼結構

import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient();

const session = await client.createSession({
  model: "gpt-4.1",
});

const response = await session.sendAndWait({
  prompt: "What is 2 + 2?",
});

console.log(response?.data.content);
await client.stop();