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

    Improvements

    Se alle højdepunkter 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øjdepunkter 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 opdateringer