До вмісту

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.3.1

    Timed-Out Shell Commands Keep Running

    A shell command still running when its timeout expires now moves to the background instead of being killed, so long builds and test runs finish and report back. A foreground timeout: 0 now means the default 120 seconds.#63699

    Compaction Without the Wait

    As a session nears automatic compaction, the summary is now written in the background, so your next prompt doesn't pause for it. Set compaction.background: false to turn it off; a background summary that ends up unused still costs tokens.#64290

    Усі головні зміни v2.3.1

    Покращення

    • Core, SDKServer requests that crash now return a 500 with a readable JSON UnknownError body instead of an empty one. Storage problems name the cause (for example "Storage is full" or "Storage is read-only"); other crashes include a ref you can find in the server log.#64022
    • Core, SDKExperimental schedules are now automations, behind the automations flag (the old schedules flag still works). An automation runs on a time, an interval, a cron or a pushed MCP event, and either sends a prompt (to the creating session, another session or a new subagent) or runs a Code Mode program that decides whether to send one. Use /automation or the automation_* tools. Active or paused plain prompt schedules carry over; schedules with a condition or run limit, and finished ones, are dropped.#64160

    Виправлення

    • SDKApps embedding the SDK with an in-memory database no longer import the user's legacy auth.json credentials. Only a database file opened by path imports them.#63716
  2. v2.3.0

    Event subscriptions can now receive experimental.mcp.event events from MCP event subscriptions

    Усі головні зміни v2.3.0

    Покращення

    • SDKModel capability schemas now advertise supported freeform tool-input formats.
    • SDKSession throughput is now measured from the first streamed token.
    • SDKSession creation documentation now clarifies the parentID field.
  3. v2.2.7

    session.generate returns tokens and cost along with text

    Усі головні зміни v2.2.7

    Несумісні зміни

    SDK: fewer endpoints wait for plugins to load

    On a Location that is still loading plugins, agent.list returns the agents loaded so far, and integration.list, usage.limits, vcs.init, rpc.call and artifact.* no longer wait up to 5 seconds. Entries and actions that a plugin provides appear when it finishes loading, so refresh on the matching *.updated event. Model, provider, generate.*, voice.* and websearch.query endpoints still wait.

    #62796#63040

    Покращення

    • SDKcredential.updated includes the integrationID and credentialID of the login that changed.#62762
    • SDKPredicate questions in client.experimental.generate.decisions accept optional criteria: { true?, false? }.#62819
Усі оновлення