본문으로 건너뛰기

SDK

직접 만든 스크립트, CI 작업, 도구에서 OpenCode를 제어하세요. SDK는 내 설정과 모델로 OpenCode를 내 프로세스 안에서 실행하며, 타입이 지정된 클라이언트가 세션을 만들고, 프롬프트를 보내고, 모든 이벤트를 스트리밍합니다.

기능

코드로 CI 고치기

짧은 스크립트가 OpenCode에게 실패한 테스트를 고치게 한 뒤 다시 실행합니다.

모든 단계 추적

이벤트를 스트리밍해 에이전트가 호출하는 도구를 실시간으로 확인하세요.

나만의 도구 만들기

몇 줄의 코드로 OpenCode를 봇, 대시보드, 워크플로에 연결하세요.

내 프로세스 안에서

내 설정과 모델로 OpenCode를 내 프로세스 안에서 실행합니다.

  • TypeScript 클라이언트@opencode/client와 같은 값을 쓰는 타입 지정 요청과 이벤트.
  • 코드로 세션 생성어떤 스크립트에서든 세션을 만들고 프롬프트를 보내세요.
  • 모든 모델OpenCode 설정에 있는 모델을 그대로 사용합니다.
  • npm 또는 bunnpm i @opencode/sdk 또는 bun add @opencode/sdk로 설치하세요.
  • 인프로세스 호스트네트워크를 거치지 않고 메모리에서 OpenCode를 실행합니다.
  • 내 플러그인인프로세스 호스트를 만들 때 직접 만든 플러그인을 넘기세요.
  • Promise 또는 Effect같은 값을 돌려주는 Promise API와 Effect API.
  • Cloudflare WorkersWorkers의 Cloudflare Durable Object 안에서 OpenCode를 실행하세요.

  • npmnpm i @opencode/sdk
  • bunbun add @opencode/sdk
SDK 문서 읽기

변경 내역

  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

    v2.3.1의 하이라이트 모두 보기

    개선 사항

    • 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

    수정 사항

    • 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

    v2.3.0의 하이라이트 모두 보기

    개선 사항

    • 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

    v2.2.7의 하이라이트 모두 보기

    호환성이 깨지는 변경

    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

    개선 사항

    • 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
전체 업데이트 보기