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.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
  2. v2.2.6

    Improvements

    Se alle høydepunkter i v2.2.6

    Forbedringer

    • SDKAdded client.experimental.job.list() and its Effect equivalent for listing background shell, subagent, and image jobs, with session, descendant, kind, and status filters.#60698
    • SDKServer embedders can provide a custom fetch implementation for OpenCode HTTP, model, web, and remote MCP traffic.#61582
  3. 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

    Se alle høydepunkter i v2.2.4

    Forbedringer

    • SDKExtended client.experimental.persistentPty.update to rename terminals or clear a user title, and exposed userTitle plus persistent-pty.updated events.#60329
Se alle oppdateringer