Zum Inhalt springen

SDK

Steuere OpenCode aus deinen eigenen Skripten, CI-Jobs und Tools. Das SDK führt OpenCode in deinem Prozess aus, mit deiner Konfiguration und deinen Modellen, und sein typisierter Client erstellt Sessions, sendet Prompts und streamt jedes Event.

Funktionen

CI per Code reparieren

Ein Skript lässt OpenCode kaputte Tests reparieren und führt sie neu aus.

Jeden Schritt verfolgen

Streame Events und sieh jedes Tool, das der Agent aufruft, in Echtzeit.

Eigene Tools bauen

Binde OpenCode mit wenigen Zeilen in Bots, Dashboards und Workflows ein.

In deinem Prozess

OpenCode läuft in deinem Prozess, mit deiner Config und deinen Modellen.

  • TypeScript-ClientTypisierte Requests und Events, mit denselben Werten wie @opencode/client.
  • Sessions aus CodeErstelle Sessions und sende Prompts aus jedem Skript.
  • Jedes ModellNutzt die Modelle, die dein OpenCode-Setup hat.
  • npm oder bunInstalliere es mit npm i @opencode/sdk oder bun add @opencode/sdk.
  • In-Process-HostFührt OpenCode im Speicher aus, ohne Umweg übers Netzwerk.
  • Deine PluginsÜbergib eigene Plugins, wenn du den In-Process-Host erstellst.
  • Promise oder EffectEine Promise-API und eine Effect-API mit denselben Werten.
  • Cloudflare WorkersFühre OpenCode in einem Cloudflare Durable Object auf Workers aus.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
SDK-Doku lesen

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

    Alle Highlights in v2.3.1 ansehen

    Verbesserungen

    • 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

    Fehlerbehebungen

    • 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

    Alle Highlights in v2.3.0 ansehen

    Verbesserungen

    • 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

    Alle Highlights in v2.2.7 ansehen

    Breaking Changes

    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

    Verbesserungen

    • 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
Alle Updates ansehen