文档
Documentação em Português
SDK

SDK

O SDK do OpenCode fornece um cliente com tipos seguros para interação programática com o servidor do OpenCode.

Instalação

npm install @opencode-ai/sdk

Configuração do Cliente

Instância Completa

import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()

Apenas Cliente

import { createOpencodeClient } from "@opencode-ai/sdk"
const client = createOpencodeClient({
  baseUrl: "http://localhost:4096"
})

Configuração

const opencode = await createOpencode({
  hostname: "127.0.0.1",
  port: 4096,
  config: {
    model: "anthropic/claude-3-5-sonnet"
  }
})

Suporte TypeScript

import type { Session, Message, Part } from "@opencode-ai/sdk"

Referência da API

Health Check

const health = await client.global.health()

Sessões

await client.session.list()
await client.session.create()
await client.session.prompt({
  path: { id: sessionId },
  body: {
    model: { providerID: "anthropic", modelID: "claude-3-5-sonnet" },
    parts: [{ type: "text", text: "Your query" }]
  }
})

Arquivos

const content = await client.file.read({
  query: { path: "src/index.ts" }
})

Eventos

const events = await client.event.subscribe()
for await (const event of events.stream) {
  console.log("Event:", event.type)
}