Pular para o conteúdo

SDK

Controle o OpenCode pelos seus scripts, jobs de CI e ferramentas. O SDK roda o OpenCode dentro do seu processo, com sua configuração e seus modelos, e o cliente tipado cria sessões, envia prompts e transmite cada evento.

Recursos

Corrija o CI

Um script pede ao OpenCode para corrigir testes com falha e os roda de novo.

Acompanhe cada passo

Transmita eventos para ver cada ferramenta que o agente chama, em tempo real.

Crie suas ferramentas

Integre o OpenCode a bots, dashboards e fluxos de trabalho com poucas linhas.

No seu processo

Roda o OpenCode no seu processo, com sua configuração e seus modelos.

  • Cliente TypeScriptRequisições e eventos tipados, com os mesmos valores de @opencode/client.
  • Sessões pelo códigoCrie sessões e envie prompts de qualquer script.
  • Todo modeloUsa os modelos que o seu OpenCode tiver configurados.
  • npm ou bunInstale com npm i @opencode/sdk ou bun add @opencode/sdk.
  • Host no processoRoda o OpenCode na memória, sem passar pela rede.
  • Seus pluginsPasse seus próprios plugins ao criar o host no processo.
  • Promise ou EffectUma API Promise e uma API Effect com os mesmos valores.
  • Cloudflare WorkersRode o OpenCode em um Durable Object da Cloudflare no Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Ler a documentação do 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

    Ver todos os destaques da v2.3.1

    Melhorias

    • 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

    Correções

    • 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

    Ver todos os destaques da v2.3.0

    Melhorias

    • 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

    Ver todos os destaques da v2.2.7

    Mudanças incompatíveis

    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

    Melhorias

    • 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
Ver todas as novidades