Hopp til innholdet

SDK

Styr OpenCode fra dine egne skript, CI-jobber og verktøy. SDK-et kjører OpenCode i din egen prosess, med konfigurasjonen og modellene dine, og den typede klienten oppretter sesjoner, sender prompter og strømmer alle hendelser.

Funksjoner

Fiks CI fra kode

Et kort skript ber OpenCode fikse tester som feiler, og kjører dem så på nytt.

Følg hvert steg

Strøm hendelser for å se hvert verktøy agenten kaller, idet det skjer.

Lag egne verktøy

Koble OpenCode inn i boter, dashbord og arbeidsflyter med noen få linjer.

I prosessen din

Kjører OpenCode i prosessen din, med konfigurasjonen og modellene dine.

  • TypeScript-klientTypede forespørsler og hendelser, med de samme verdiene som @opencode/client.
  • Sesjoner fra kodeOpprett sesjoner og send prompter fra et hvilket som helst skript.
  • Alle modellerBruker modellene OpenCode-oppsettet ditt har.
  • npm eller bunInstaller med npm i @opencode/sdk eller bun add @opencode/sdk.
  • In-process-vertKjører OpenCode i minnet, uten nettverkshopp.
  • Dine pluginsSend inn egne plugins når du oppretter in-process-verten.
  • Promise eller EffectEt Promise-API og et Effect-API med de samme verdiene.
  • Cloudflare WorkersKjør OpenCode i et Cloudflare Durable Object på Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Les SDK-dokumentasjonen

Endringslogg

  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øydepunkter 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øydepunkter 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øydepunkter i v2.2.7

    Endringer som bryter

    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 oppdateringer