К содержимому

SDK

Управляйте OpenCode из своих скриптов, CI-задач и инструментов. SDK запускает OpenCode внутри вашего процесса, с вашей конфигурацией и моделями, а его типизированный клиент создаёт сессии, отправляет промпты и передаёт поток всех событий.

Возможности

Чините CI из кода

Скрипт просит OpenCode починить упавшие тесты и запускает их снова.

Каждый шаг на виду

Получайте поток событий и видьте каждый инструмент, который вызывает агент.

Свои инструменты

Встраивайте OpenCode в ботов, дашборды и процессы парой строк кода.

В вашем процессе

Запускает OpenCode в вашем процессе с вашими настройками и моделями.

  • TypeScript-клиентТипизированные запросы и события, те же значения, что и в @opencode/client.
  • Сессии из кодаСоздавайте сессии и отправляйте промпты из любого скрипта.
  • Любая модельИспользует модели, настроенные в вашем OpenCode.
  • npm или bunУстановите через npm i @opencode/sdk или bun add @opencode/sdk.
  • Хост в процессеЗапускает OpenCode в памяти, без сетевых запросов.
  • Ваши плагиныПередайте свои плагины при создании хоста в процессе.
  • Promise или EffectPromise API и Effect API с одинаковыми значениями.
  • Cloudflare WorkersЗапускайте OpenCode в Cloudflare Durable Object на Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Документация SDK

Список изменений

  1. v2.2.4

    Publish Interactive Artifacts

    Enable "experimental": { "artifacts": true } in opencode.json to let agents publish, update, and serve HTML or static artifacts through the built-in local provider or plugin-provided storage.#60351

    Улучшения

    • SDKExtended client.experimental.persistentPty.update to rename terminals or clear a user title, and exposed userTitle plus persistent-pty.updated events.#60329
  2. v2.2.3

    Added lazy loading for stored image references when experimental.media_blob is enabled

    Added lazy loading for stored image references when experimental.media_blob is enabled. Images are downloaded only for previews, while undo, revert, fork, and prompt recall restore referenced attachments safely.#60116

    Улучшения

    • SDKPreserved partial LLMResponse output on AIError.partial when generation, object generation, or a tool loop fails.#60477
    • SDKUnified Effect and Promise tool declarations around tool(...), with optional output schemas and executable or declaration-only tools.#60407
    • SDKAdded typed OpenRouter debug, models, plugins, provider, and user options to the Responses route.#60044

    Исправления

    • SDKMatched the Promise AI client more closely to the Effect API and accepted typed tools in loops.#60465#60390
    • SDKKept tools whose execute handler can throw available to the AI client.#60431
    • SDKContinued polling queued media generations when providers return unknown intermediate statuses.#59988
    • SDKStopped sending an incompatible filename alongside file_url on OpenAI Responses requests.#60382
  3. v2.2.2

    Exposed SessionInfo.time.busy for the latest execution’s start time

    Улучшения

    • SDKAdded if and until inputs for client.experimental.schedule.create, plus schedule check results and output fields.#60137
    • SDKAdded optional source metadata to prompt file attachments.
Все обновления