SDK

Cliente JS com tipos seguros para o servidor opencode.

O SDK JS/TS do opencode fornece um cliente com tipos seguros para interagir com o servidor. Use-o para construir integrações e controlar o opencode programaticamente.

Saiba mais sobre como o servidor funciona. Confira os projetos construídos pela comunidade.

Instalação

Instale o SDK do npm:

npm install @opencode-ai/sdk

Criar cliente

Crie uma instância do opencode:

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

Isso inicia tanto um servidor quanto um cliente.

Opções

Opção	Tipo	Descrição	Padrão
`hostname`	`string`	Nome do host do servidor	`127.0.0.1`
`port`	`number`	Porta do servidor	`4096`
`signal`	`AbortSignal`	Sinal de cancelamento	`undefined`
`timeout`	`number`	Timeout em ms para início do servidor	`5000`
`config`	`Config`	Objeto de configuração	`{}`

Configuração

Você pode passar um objeto de configuração para personalizar o comportamento. A instância ainda lê seu opencode.json, mas você pode sobrescrever ou adicionar configuração inline:

import { createOpencode } from "@opencode-ai/sdk"
 
const opencode = await createOpencode({
  hostname: "127.0.0.1",
  port: 4096,
  config: {
    model: "anthropic/claude-3-5-sonnet-20241022",
  },
})
 
console.log(`Server running at ${opencode.server.url}`)
opencode.server.close()

Apenas cliente

Se você já tem uma instância do opencode em execução, pode criar uma instância de cliente para se conectar a ela:

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

Opções

Opção	Tipo	Descrição	Padrão
`baseUrl`	`string`	URL do servidor	`http://localhost:4096`
`fetch`	`function`	Implementação personalizada de fetch	`globalThis.fetch`
`parseAs`	`string`	Método de análise de resposta	`auto`
`responseStyle`	`string`	Estilo de retorno: `data` ou `fields`	`fields`
`throwOnError`	`boolean`	Lançar erros em vez de retornar	`false`

Tipos

O SDK inclui definições TypeScript para todos os tipos de API. Importe-os diretamente:

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

Todos os tipos são gerados a partir da especificação OpenAPI do servidor e estão disponíveis no arquivo de tipos (opens in a new tab).

Erros

O SDK pode lançar erros que você pode capturar e tratar:

try {
  await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
  console.error("Failed to get session:", (error as Error).message)
}

APIs

O SDK expõe todas as APIs do servidor através de um cliente com tipos seguros.

Global

Método	Descrição	Resposta
`global.health()`	Verificar saúde e versão do servidor	`{ healthy: true, version: string }`

Exemplos

const health = await client.global.health()
console.log(health.data.version)

App

Método	Descrição	Resposta
`app.log()`	Escrever uma entrada de log	`boolean`
`app.agents()`	Listar todos os agentes disponíveis	`Agent[]` (opens in a new tab)

Exemplos

// Escrever uma entrada de log
await client.app.log({
  body: {
    service: "my-app",
    level: "info",
    message: "Operation completed",
  },
})
 
// Listar agentes disponíveis
const agents = await client.app.agents()

Project

Método	Descrição	Resposta
`project.list()`	Listar todos os projetos	`Project[]` (opens in a new tab)
`project.current()`	Obter projeto atual	`Project` (opens in a new tab)

Exemplos

// Listar todos os projetos
const projects = await client.project.list()
 
// Obter projeto atual
const currentProject = await client.project.current()

Path

Método	Descrição	Resposta
`path.get()`	Obter caminho atual	`Path` (opens in a new tab)

Exemplos

// Obter informações do caminho atual
const pathInfo = await client.path.get()

Config

Método	Descrição	Resposta
`config.get()`	Obter informações de configuração	`Config` (opens in a new tab)
`config.providers()`	Listar provedores e modelos padrão	`{ providers:` `Provider[]` (opens in a new tab)`, default: { [key: string]: string } }`

Exemplos

const config = await client.config.get()
 
const { providers, default: defaults } = await client.config.providers()

Sessions

Método	Descrição	Notas
`session.list()`	Listar sessões	Retorna `Session[]` (opens in a new tab)
`session.get({ path })`	Obter sessão	Retorna `Session` (opens in a new tab)
`session.children({ path })`	Listar sessões filhas	Retorna `Session[]` (opens in a new tab)
`session.create({ body })`	Criar sessão	Retorna `Session` (opens in a new tab)
`session.delete({ path })`	Excluir sessão	Retorna `boolean`
`session.update({ path, body })`	Atualizar propriedades da sessão	Retorna `Session` (opens in a new tab)
`session.init({ path, body })`	Analisar app e criar `AGENTS.md`	Retorna `boolean`
`session.abort({ path })`	Abortar sessão em execução	Retorna `boolean`
`session.share({ path })`	Compartilhar sessão	Retorna `Session` (opens in a new tab)
`session.unshare({ path })`	Deixar de compartilhar sessão	Retorna `Session` (opens in a new tab)
`session.summarize({ path, body })`	Resumir sessão	Retorna `boolean`
`session.messages({ path })`	Listar mensagens em uma sessão	Retorna `{ info:` `Message` (opens in a new tab)`, parts:` `Part[]` (opens in a new tab)`}[]`
`session.message({ path })`	Obter detalhes da mensagem	Retorna `{ info:` `Message` (opens in a new tab)`, parts:` `Part[]` (opens in a new tab)`}`
`session.prompt({ path, body })`	Enviar mensagem de prompt	`body.noReply: true` retorna UserMessage (apenas contexto). Padrão retorna `AssistantMessage` (opens in a new tab) com resposta de IA
`session.command({ path, body })`	Enviar comando para sessão	Retorna `{ info:` `AssistantMessage` (opens in a new tab)`, parts:` `Part[]` (opens in a new tab)`}`
`session.shell({ path, body })`	Executar comando shell	Retorna `AssistantMessage` (opens in a new tab)
`session.revert({ path, body })`	Reverter uma mensagem	Retorna `Session` (opens in a new tab)
`session.unrevert({ path })`	Restaurar mensagens revertidas	Retorna `Session` (opens in a new tab)
`postSessionByIdPermissionsByPermissionId({ path, body })`	Responder a solicitação de permissão	Retorna `boolean`

Exemplos

// Criar e gerenciar sessões
const session = await client.session.create({
  body: { title: "My session" },
})
 
const sessions = await client.session.list()
 
// Enviar mensagem de prompt
const result = await client.session.prompt({
  path: { id: session.id },
  body: {
    model: { providerID: "anthropic", modelID: "claude-3-5-sonnet-20241022" },
    parts: [{ type: "text", text: "Hello!" }],
  },
})
 
// Injetar contexto sem acionar resposta de IA (útil para plugins)
await client.session.prompt({
  path: { id: session.id },
  body: {
    noReply: true,
    parts: [{ type: "text", text: "You are a helpful assistant." }],
  },
})

Files

Método	Descrição	Resposta
`find.text({ query })`	Buscar texto em arquivos	Array de objetos de correspondência com `path`, `lines`, `line_number`, `absolute_offset`, `submatches`
`find.files({ query })`	Encontrar arquivos e diretórios por nome	`string[]` (caminhos)
`find.symbols({ query })`	Encontrar símbolos do workspace	`Symbol[]` (opens in a new tab)
`file.read({ query })`	Ler um arquivo	`{ type: "raw" \| "patch", content: string }`
`file.status({ query? })`	Obter status de arquivos rastreados	`File[]` (opens in a new tab)

find.files suporta alguns campos de consulta opcionais:

type: "file" ou "directory"
directory: sobrescrever a raiz do projeto para a busca
limit: máximo de resultados (1-200)

Exemplos

// Buscar e ler arquivos
const textResults = await client.find.text({
  query: { pattern: "function.*opencode" },
})
 
const files = await client.find.files({
  query: { query: "*.ts", type: "file" },
})
 
const directories = await client.find.files({
  query: { query: "packages", type: "directory", limit: 20 },
})
 
const content = await client.file.read({
  query: { path: "src/index.ts" },
})

TUI

Método	Descrição	Resposta
`tui.appendPrompt({ body })`	Adicionar texto ao prompt	`boolean`
`tui.openHelp()`	Abrir diálogo de ajuda	`boolean`
`tui.openSessions()`	Abrir seletor de sessões	`boolean`
`tui.openThemes()`	Abrir seletor de temas	`boolean`
`tui.openModels()`	Abrir seletor de modelos	`boolean`
`tui.submitPrompt()`	Enviar o prompt atual	`boolean`
`tui.clearPrompt()`	Limpar o prompt	`boolean`
`tui.executeCommand({ body })`	Executar um comando	`boolean`
`tui.showToast({ body })`	Mostrar notificação toast	`boolean`

Exemplos

// Controlar interface TUI
await client.tui.appendPrompt({
  body: { text: "Add this to prompt" },
})
 
await client.tui.showToast({
  body: { message: "Task completed", variant: "success" },
})

Auth

Método	Descrição	Resposta
`auth.set({ ... })`	Definir credenciais de autenticação	`boolean`

Exemplos

await client.auth.set({
  path: { id: "anthropic" },
  body: { type: "api", key: "your-api-key" },
})

Events

Método	Descrição	Resposta
`event.subscribe()`	Stream de eventos enviados pelo servidor	Stream de eventos enviados pelo servidor

Exemplos

// Ouvir eventos em tempo real
const events = await client.event.subscribe()
for await (const event of events.stream) {
  console.log("Event:", event.type, event.properties)
}

Ferramentas Personalizadas Servidor