Przejdź do treści

SDK

Steruj OpenCode z własnych skryptów, zadań CI i narzędzi. SDK uruchamia OpenCode w Twoim procesie, z Twoją konfiguracją i modelami, a typowany klient tworzy sesje, wysyła prompty i strumieniuje każde zdarzenie.

Funkcje

Napraw CI z kodu

Skrypt prosi OpenCode o naprawę nieudanych testów i uruchamia je ponownie.

Śledź każdy krok

Strumieniuj zdarzenia, by na bieżąco widzieć każde narzędzie, którego używa agent.

Własne narzędzia

Podłącz OpenCode do botów, dashboardów i workflowów w kilku linijkach.

W Twoim procesie

Uruchamia OpenCode w Twoim procesie, z Twoją konfiguracją i modelami.

  • Klient TypeScriptTypowane żądania i zdarzenia, z tymi samymi wartościami co @opencode/client.
  • Sesje z koduTwórz sesje i wysyłaj prompty z dowolnego skryptu.
  • Każdy modelUżywa modeli skonfigurowanych w Twoim OpenCode.
  • npm lub bunZainstaluj przez npm i @opencode/sdk lub bun add @opencode/sdk.
  • Host w procesieUruchamia OpenCode w pamięci, bez ruchu sieciowego.
  • Twoje pluginyPrzekaż własne pluginy przy tworzeniu hosta w procesie.
  • Promise lub EffectAPI Promise i API Effect z tymi samymi wartościami.
  • Cloudflare WorkersUruchamiaj OpenCode w Durable Object Cloudflare na Workers.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
Czytaj dokumentację SDK

Zmiany

  1. 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

    Ulepszenia

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

    Added lazy loading for stored image references when experimental.media_blob is enabled

    Added lazy loading for stored image references when experimental.media_blob is enabled. Images are downloaded only for previews, while undo, revert, fork, and prompt recall restore referenced attachments safely.#60116

    Ulepszenia

    • SDKPreserved partial LLMResponse output on AIError.partial when generation, object generation, or a tool loop fails.#60477
    • SDKUnified Effect and Promise tool declarations around tool(...), with optional output schemas and executable or declaration-only tools.#60407
    • SDKAdded typed OpenRouter debug, models, plugins, provider, and user options to the Responses route.#60044

    Poprawki

    • SDKMatched the Promise AI client more closely to the Effect API and accepted typed tools in loops.#60465#60390
    • SDKKept tools whose execute handler can throw available to the AI client.#60431
    • SDKContinued polling queued media generations when providers return unknown intermediate statuses.#59988
    • SDKStopped sending an incompatible filename alongside file_url on OpenAI Responses requests.#60382
  3. v2.2.2

    Exposed SessionInfo.time.busy for the latest execution’s start time

    Ulepszenia

    • SDKAdded if and until inputs for client.experimental.schedule.create, plus schedule check results and output fields.#60137
    • SDKAdded optional source metadata to prompt file attachments.
Zobacz wszystkie zmiany