File size: 20,996 Bytes
3e05655 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | ---
title: SDK
description: Cliente JS seguro em tipos para o servidor opencode.
---
import config from "../../../../config.mjs"
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
O SDK JS/TS do opencode fornece um cliente seguro em tipos para interagir com o servidor.
Use-o para construir integrações e controlar o opencode programaticamente.
[Saiba mais](/docs/server) sobre como o servidor funciona. Para exemplos, confira os [projetos](/docs/ecosystem#projects) construídos pela comunidade.
---
## Instalar
Instale o SDK a partir do npm:
```bash
npm install @opencode-ai/sdk
```
---
## Criar cliente
Crie uma instância do opencode:
```javascript
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 abortar para cancelamento | `undefined` |
| `timeout` | `number` | Tempo limite em ms para iniciar o 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 pega seu `opencode.json`, mas você pode substituir ou adicionar configuração inline:
```javascript
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:
```javascript
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 de fetch personalizada | `globalThis.fetch` |
| `parseAs` | `string` | Método de análise da 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 da API. Importe-os diretamente:
```typescript
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 <a href={typesUrl}>arquivo de tipos</a>.
---
## Erros
O SDK pode lançar erros que você pode capturar e tratar:
```typescript
try {
await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
console.error("Failed to get session:", (error as Error).message)
}
```
---
## Saída Estruturada
Você pode solicitar uma saída JSON estruturada do modelo especificando um `format` com um esquema JSON. O modelo usará uma ferramenta `StructuredOutput` para retornar um JSON validado correspondente ao seu esquema.
### Uso Básico
```typescript
const result = await client.session.prompt({
path: { id: sessionId },
body: {
parts: [{ type: "text", text: "Research Anthropic and provide company info" }],
format: {
type: "json_schema",
schema: {
type: "object",
properties: {
company: { type: "string", description: "Company name" },
founded: { type: "number", description: "Year founded" },
products: {
type: "array",
items: { type: "string" },
description: "Main products",
},
},
required: ["company", "founded"],
},
},
},
})
// Acessar a saída estruturada
console.log(result.data.info.structured_output)
// { company: "Anthropic", founded: 2021, products: ["Claude", "Claude API"] }
```
### Tipos de Formato de Saída
| Tipo | Descrição |
| ------------- | --------------------------------------------------------- |
| `text` | Padrão. Resposta de texto padrão (sem saída estruturada) |
| `json_schema` | Retorna JSON validado correspondente ao esquema fornecido |
### Formato do Esquema JSON
Ao usar `type: 'json_schema'`, forneça:
| Campo | Tipo | Descrição |
| ------------ | --------------- | -------------------------------------------------------------- |
| `type` | `'json_schema'` | Obrigatório. Especifica o modo de esquema JSON |
| `schema` | `object` | Obrigatório. Objeto JSON Schema definindo a estrutura de saída |
| `retryCount` | `number` | Opcional. Número de tentativas de validação (padrão: 2) |
### Tratamento de Erros
Se o modelo falhar em produzir uma saída estruturada válida após todas as tentativas, a resposta incluirá um `StructuredOutputError`:
```typescript
if (result.data.info.error?.name === "StructuredOutputError") {
console.error("Failed to produce structured output:", result.data.info.error.message)
console.error("Attempts:", result.data.info.error.retries)
}
```
### Melhores Práticas
1. **Forneça descrições claras** nas propriedades do seu esquema para ajudar o modelo a entender quais dados extrair
2. **Use `required`** para especificar quais campos devem estar presentes
3. **Mantenha os esquemas focados** - esquemas aninhados complexos podem ser mais difíceis para o modelo preencher corretamente
4. **Defina um `retryCount` apropriado** - aumente para esquemas complexos, diminua para os simples
---
## APIs
O SDK expõe todas as APIs do servidor através de um cliente seguro em tipos.
---
### Global
| Método | Descrição | Resposta |
| ----------------- | -------------------------------------- | ------------------------------------ |
| `global.health()` | Verificar a saúde e versão do servidor | `{ healthy: true, version: string }` |
---
#### Exemplos
```javascript
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 | <a href={typesUrl}><code>Agent[]</code></a> |
---
#### Exemplos
```javascript
// Write a log entry
await client.app.log({
body: {
service: "my-app",
level: "info",
message: "Operation completed",
},
})
// List available agents
const agents = await client.app.agents()
```
---
### Projeto
| Método | Descrição | Resposta |
| ------------------- | ------------------------ | --------------------------------------------- |
| `project.list()` | Listar todos os projetos | <a href={typesUrl}><code>Project[]</code></a> |
| `project.current()` | Obter projeto atual | <a href={typesUrl}><code>Project</code></a> |
---
#### Exemplos
```javascript
// List all projects
const projects = await client.project.list()
// Get current project
const currentProject = await client.project.current()
```
---
### Caminho
| Método | Descrição | Resposta |
| ------------ | ------------------- | ---------------------------------------- |
| `path.get()` | Obter caminho atual | <a href={typesUrl}><code>Path</code></a> |
---
#### Exemplos
```javascript
// Get current path information
const pathInfo = await client.path.get()
```
---
### Configuração
| Método | Descrição | Resposta |
| -------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `config.get()` | Obter informações de configuração | <a href={typesUrl}><code>Config</code></a> |
| `config.providers()` | Listar provedores e modelos padrão | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
---
#### Exemplos
```javascript
const config = await client.config.get()
const { providers, default: defaults } = await client.config.providers()
```
---
### Sessões
| Método | Descrição | Notas |
| ---------------------------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `session.list()` | Listar sessões | Retorna <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ path })` | Obter sessão | Retorna <a href={typesUrl}><code>Session</code></a> |
| `session.children({ path })` | Listar sessões filhas | Retorna <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ body })` | Criar sessão | Retorna <a href={typesUrl}><code>Session</code></a> |
| `session.delete({ path })` | Deletar sessão | Retorna `boolean` |
| `session.update({ path, body })` | Atualizar propriedades da sessão | Retorna <a href={typesUrl}><code>Session</code></a> |
| `session.init({ path, body })` | Analisar app e criar `AGENTS.md` | Retorna `boolean` |
| `session.abort({ path })` | Abortar uma sessão em execução | Retorna `boolean` |
| `session.share({ path })` | Compartilhar sessão | Retorna <a href={typesUrl}><code>Session</code></a> |
| `session.unshare({ path })` | Descompartilhar sessão | Retorna <a href={typesUrl}><code>Session</code></a> |
| `session.summarize({ path, body })` | Resumir sessão | Retorna `boolean` |
| `session.messages({ path })` | Listar mensagens em uma sessão | Retorna `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` |
| `session.message({ path })` | Obter detalhes da mensagem | Retorna `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.prompt({ path, body })` | Enviar mensagem de prompt | `body.noReply: true` retorna UserMessage (apenas contexto). O padrão retorna <a href={typesUrl}><code>AssistantMessage</code></a> com resposta da AI. Suporta `body.outputFormat` para [saída estruturada](#saída-estruturada) |
| `session.command({ path, body })` | Enviar comando para a sessão | Retorna `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.shell({ path, body })` | Executar um comando shell | Retorna <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.revert({ path, body })` | Reverter uma mensagem | Retorna <a href={typesUrl}><code>Session</code></a> |
| `session.unrevert({ path })` | Restaurar mensagens revertidas | Retorna <a href={typesUrl}><code>Session</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | Responder a um pedido de permissão | Retorna `boolean` |
---
#### Exemplos
```javascript
// Create and manage sessions
const session = await client.session.create({
body: { title: "My session" },
})
const sessions = await client.session.list()
// Send a prompt message
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!" }],
},
})
// Inject context without triggering AI response (useful for plugins)
await client.session.prompt({
path: { id: session.id },
body: {
noReply: true,
parts: [{ type: "text", text: "You are a helpful assistant." }],
},
})
```
---
### Arquivos
| Método | Descrição | Resposta |
| ------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `find.text({ query })` | Pesquisar 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 no workspace | <a href={typesUrl}><code>Symbol[]</code></a> |
| `file.read({ query })` | Ler um arquivo | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | Obter status para arquivos rastreados | <a href={typesUrl}><code>File[]</code></a> |
`find.files` suporta alguns campos de consulta opcionais:
- `type`: `"file"` ou `"directory"`
- `directory`: substituir a raiz do projeto para a pesquisa
- `limit`: resultados máximos (1–200)
---
#### Exemplos
```javascript
// Search and read files
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 o diálogo de ajuda | `boolean` |
| `tui.openSessions()` | Abrir o seletor de sessões | `boolean` |
| `tui.openThemes()` | Abrir o seletor de temas | `boolean` |
| `tui.openModels()` | Abrir o 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
```javascript
// Control TUI interface
await client.tui.appendPrompt({
body: { text: "Add this to prompt" },
})
await client.tui.showToast({
body: { message: "Task completed", variant: "success" },
})
```
---
### Autenticação
| Método | Descrição | Resposta |
| ------------------- | ----------------------------------- | --------- |
| `auth.set({ ... })` | Definir credenciais de autenticação | `boolean` |
---
#### Exemplos
```javascript
await client.auth.set({
path: { id: "anthropic" },
body: { type: "api", key: "your-api-key" },
})
```
---
### Eventos
| Método | Descrição | Resposta |
| ------------------- | --------------------------------------- | --------------------------------------- |
| `event.subscribe()` | Fluxo de eventos enviados pelo servidor | Fluxo de eventos enviados pelo servidor |
---
#### Exemplos
```javascript
// Listen to real-time events
const events = await client.event.subscribe()
for await (const event of events.stream) {
console.log("Event:", event.type, event.properties)
}
```
|