Совместимость SDK и CLI

Примечание.

          Второй пилот SDK в настоящее время находится в public preview. Функциональность и доступность могут меняться.

          GitHub Copilot SDK Общается с GitHub Copilot CLI JSON-RPC протоколом. Функции должны быть явно раскрыты через этот протокол, чтобы быть доступными в SDK. Многие интерактивные функции CLI специфичны для терминала и недоступны программно.

Сравнение функций

Доступно в формате SDK

Функция	Метод SDK	Примечания
Управление сеансами
Создание сеанса	`createSession()`	Полная поддержка конфигурации
Сессия резюме	`resumeSession()`	С бесконечными сессионными рабочими пространствами
Завершить сеанс.	`disconnect()`	Выпуск ресурсов в памяти
Сессия уничтожения	`destroy()`	Вместо нее следует использовать `disconnect()`.
Удаление сеанса	`deleteSession()`	Извлечение из хранения
Перечисление сеансов	`listSessions()`	Все сохранённые сессии
Получите последнюю сессию	`getLastSessionId()`	Краткое резюме
Сессия на переднем плане	`getForegroundSessionId()`	Многосессионная координация
Задайте сессию на переднем плане	`setForegroundSessionId()`	Многосессионная координация
Сообщения
Отправить сообщение	`send()`	С приложениями
Отправь и жди	`sendAndWait()`	Блоки до завершения
Рулевое управление (режим мгновенности)	`send({ mode: "immediate" })`	Ввод в середине поворота без прекращения
Очередь (режим очереди)	`send({ mode: "enqueue" })`	Буфер для последовательной обработки (по умолчанию)
Вложенные файлы	`send({ attachments: [{ type: "file", path }] })`	Изображения автоматически кодируются и изменяются в размере
Вложения в каталог	`send({ attachments: [{ type: "directory", path }] })`	Прикрепить контекст каталога
Узнать историю	`getMessages()`	Все сессионные мероприятия
Отмена	`abort()`	Отменить запрос на борт
Инструменты
Регистрируйте пользовательские инструменты	`registerTools()`	Полная поддержка JSON Schema
Контроль прав на инструмент

          `onPreToolUse` Крюк | Разрешить/отрицать/просить |

Недоступно в SDK (только для CLI)

Функция	Команда/опция CLI	Причина
Экспорт сессий
Экспорт в файл

          `--share`, `/share` | Не по протоколу |

Обходные пути

Экспорт сессий

Эта --share опция недоступна через SDK. Чтобы решить эту проблему, сделайте следующее:

Собирайте события вручную: Подпишитесь на события сессий и создайте собственный экспорт:

TypeScript

const events: SessionEvent[] = [];
session.on((event) => events.push(event));
// ... after conversation ...
const messages = await session.getMessages();
// Format as markdown yourself

const events: SessionEvent[] = [];
session.on((event) => events.push(event));
// ... after conversation ...
const messages = await session.getMessages();
// Format as markdown yourself

Используйте CLI напрямую для одноразового экспорта.

Контроль разрешений

SDK использует модель отказов по умолчанию. Все запросы на разрешения (запись файлов, команды shell, получение URL и другие) отклоняются, если только ваше приложение не предоставляет обработчик onPermissionRequest .

Вместо --allow-all-paths или --yolo, используйте обработчик разрешений:

TypeScript

const session = await client.createSession({
  onPermissionRequest: approveAll,
});

const session = await client.createSession({
  onPermissionRequest: approveAll,
});

Отслеживание использования токенов

Вместо /usage, подписывайтесь на события использования:

TypeScript

session.on("assistant.usage", (event) => {
  console.log("Tokens used:", {
    input: event.data.inputTokens,
    output: event.data.outputTokens,
  });
});

session.on("assistant.usage", (event) => {
  console.log("Tokens used:", {
    input: event.data.inputTokens,
    output: event.data.outputTokens,
  });
});

Уплотнение контекста

Вместо /compactэтого настройте автоматическое уплотнение или активируйте её вручную:

TypeScript

// Automatic compaction via config
const session = await client.createSession({
  infiniteSessions: {
    enabled: true,
    backgroundCompactionThreshold: 0.80,  // Start background compaction at 80% context utilization
    bufferExhaustionThreshold: 0.95,      // Block and compact at 95% context utilization
  },
});

// Manual compaction (experimental)
const result = await session.rpc.compaction.compact();
console.log(`Removed ${result.tokensRemoved} tokens, ${result.messagesRemoved} messages`);

// Automatic compaction via config
const session = await client.createSession({
  infiniteSessions: {
    enabled: true,
    backgroundCompactionThreshold: 0.80,  // Start background compaction at 80% context utilization
    bufferExhaustionThreshold: 0.95,      // Block and compact at 95% context utilization
  },
});

// Manual compaction (experimental)
const result = await session.rpc.compaction.compact();
console.log(`Removed ${result.tokensRemoved} tokens, ${result.messagesRemoved} messages`);

Примечание.

Пороги — это коэффициенты использования контекста (0,0-1,0), а не абсолютное количество токенов.

Управление планами

Программно читайте и пишите планы сессий:

TypeScript

// Read the current plan
const plan = await session.rpc.plan.read();
if (plan.exists) {
  console.log(plan.content);
}

// Update the plan
await session.rpc.plan.update({ content: "# My Plan\n- Step 1\n- Step 2" });

// Delete the plan
await session.rpc.plan.delete();

// Read the current plan
const plan = await session.rpc.plan.read();
if (plan.exists) {
  console.log(plan.content);
}

// Update the plan
await session.rpc.plan.update({ content: "# My Plan\n- Step 1\n- Step 2" });

// Delete the plan
await session.rpc.plan.delete();

Управление сообщениями

Введите сообщение в текущий ход LLM без прерывания:

TypeScript

// Steer the agent mid-turn
await session.send({ prompt: "Focus on error handling first", mode: "immediate" });

// Default: enqueue for next turn
await session.send({ prompt: "Next, add tests" });

// Steer the agent mid-turn
await session.send({ prompt: "Focus on error handling first", mode: "immediate" });

// Default: enqueue for next turn
await session.send({ prompt: "Next, add tests" });

Ограничения протокола

SDK может получать доступ только к функциям, открытым через протокол JSON-RPC CLI. Если вам нужна функция CLI, которая недоступна:

Проверьте альтернативы: Многие функции имеют аналоги SDK (см. выше раздел обходных путей ).
Используйте CLI напрямую: Для единичных операций используйте CLI.
Запросить функцию: Откройте проблему в репозитории github/copilot-sdk , чтобы запросить поддержку протокола.

Совместимость версий

Диапазон протокола SDK	Версия протокола CLI	Совместимость
v2-v3	версия 3	Полная поддержка
v2-v3	версия 2	Поддерживается автоматическими адаптерами v2

SDK согласует версии протокола с CLI при запуске. SDK поддерживает версии протокола 2–3. При подключении к серверу CLI v2 SDK автоматически адаптируется tool.call и permission.request сообщает к модели событий v3 — без изменений кода.

Вы можете проверить версии во время выполнения:

TypeScript

const status = await client.getStatus();
console.log("Protocol version:", status.protocolVersion);

const status = await client.getStatus();
console.log("Protocol version:", status.protocolVersion);

Совместимость SDK и CLI

Кто может использовать эту функцию?

В этой статье

Сравнение функций

Доступно в формате SDK

Недоступно в SDK (только для CLI)

Обходные пути

Экспорт сессий

Контроль разрешений

Отслеживание использования токенов

Уплотнение контекста

Управление планами

Управление сообщениями

Ограничения протокола

Совместимость версий