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

    Forbedringer

    • 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

    Forbedringer

    • 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

    Rettelser

    • 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

    Forbedringer

    • 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.
Se alle oppdateringer