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();