Aller au contenu

SDK

Pilotez OpenCode depuis vos scripts, jobs CI et outils. Le SDK exécute OpenCode dans votre processus, avec votre configuration et vos modèles, et son client typé crée des sessions, envoie des prompts et diffuse chaque événement.

Fonctionnalités

Réparer la CI en code

Un court script demande à OpenCode de corriger les tests en échec, puis les relance.

Suivre chaque étape

Diffusez les événements pour voir chaque outil appelé par l'agent, en temps réel.

Créez vos outils

Intégrez OpenCode à des bots, tableaux de bord et workflows en quelques lignes.

Dans votre processus

Exécute OpenCode dans votre processus, avec votre config et vos modèles.

  • Client TypeScriptRequêtes et événements typés, avec les mêmes valeurs que @opencode/client.
  • Sessions par le codeCréez des sessions et envoyez des prompts depuis n'importe quel script.
  • Tout modèleUtilise les modèles configurés dans votre OpenCode.
  • npm ou bunInstallez-le avec npm i @opencode/sdk ou bun add @opencode/sdk.
  • Hôte in-processExécute OpenCode en mémoire, sans passer par le réseau.
  • Vos pluginsPassez vos propres plugins à la création de l'hôte in-process.
  • Promise ou EffectUne API Promise et une API Effect, avec les mêmes valeurs.
  • Cloudflare WorkersExécutez OpenCode dans un Durable Object Cloudflare sur Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Lire la doc du SDK

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

    Voir tous les points forts de v2.3.1

    Améliorations

    • 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

    Correctifs

    • 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

    Voir tous les points forts de v2.3.0

    Améliorations

    • 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

    Voir tous les points forts de v2.2.7

    Changements majeurs

    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

    Améliorations

    • 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
Voir toutes les mises à jour