Spring til indhold

SDK

Styr OpenCode fra dine egne scripts, CI-jobs og værktøjer. SDK'et kører OpenCode i din egen proces med din konfiguration og dine modeller, og dets typede klient opretter sessioner, sender prompts og streamer alle events.

Funktioner

Ret CI fra kode

Et kort script beder OpenCode rette fejlende tests og kører dem så igen.

Følg hvert trin

Stream events for at se hvert værktøj, agenten kalder, mens det sker.

Byg egne værktøjer

Kobl OpenCode på bots, dashboards og workflows med få linjer.

I din proces

Kører OpenCode i din proces med din konfiguration og dine modeller.

  • TypeScript-klientTypede requests og events med de samme værdier som @opencode/client.
  • Sessioner fra kodeOpret sessioner og send prompts fra ethvert script.
  • Enhver modelBruger de modeller, din OpenCode-opsætning har.
  • npm eller bunInstaller det med npm i @opencode/sdk eller bun add @opencode/sdk.
  • In-process-hostKører OpenCode i hukommelsen uden netværkshop.
  • Dine pluginsGiv dine egne plugins med, når du opretter in-process-hosten.
  • Promise eller EffectEn Promise-API og en Effect-API med de samme værdier.
  • Cloudflare WorkersKør OpenCode i et Cloudflare Durable Object på Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Læs SDK-dokumentationen

Changelog

  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

    Se alle højdepunkter i v2.3.1

    Forbedringer

    • 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

    Rettelser

    • 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

    Se alle højdepunkter i v2.3.0

    Forbedringer

    • 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

    Se alle højdepunkter i v2.2.7

    Inkompatible ændringer

    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

    Forbedringer

    • 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
Se alle opdateringer