До вмісту

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.
Усі оновлення