SDK

Типобезопасный JS-клиент для сервера opencode.

SDK JS/TS с открытым кодом предоставляет типобезопасный клиент для взаимодействия с сервером. Используйте его для создания интеграции и программного управления открытым кодом.

Узнайте больше о том, как работает сервер. Примеры можно найти в projects, созданном сообществом.

Установить

Установите SDK из npm:

npm install @opencode-ai/sdk

Создать клиента

Создайте экземпляр opencode:

import { createOpencode } from "@opencode-ai/sdk"

const { client } = await createOpencode()

Это запускает и сервер, и клиент.

Параметры

Вариант	Тип	Описание	По умолчанию
`hostname`	`string`	Server hostname	`127.0.0.1`
`port`	`number`	Server port	`4096`
`signal`	`AbortSignal`	Abort signal for cancellation	`undefined`
`timeout`	`number`	Timeout in ms for server start	`5000`
`config`	`Config`	Configuration object	`{}`

Конфигурация

Вы можете передать объект конфигурации для настройки поведения. Экземпляр по-прежнему получает ваш opencode.json, но вы можете переопределить или добавить встроенную конфигурацию:

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()

Только клиент

Если у вас уже есть работающий экземпляр opencode, вы можете создать экземпляр клиента для подключения к нему:

import { createOpencodeClient } from "@opencode-ai/sdk"

const client = createOpencodeClient({
  baseUrl: "http://localhost:4096",
})

Параметры

Вариант	Тип	Описание	По умолчанию
`baseUrl`	`string`	URL of the server	`http://localhost:4096`
`fetch`	`function`	Custom fetch implementation	`globalThis.fetch`
`parseAs`	`string`	Response parsing method	`auto`
`responseStyle`	`string`	Return style: `data` or `fields`	`fields`
`throwOnError`	`boolean`	Throw errors instead of return	`false`

Типы

SDK включает определения TypeScript для всех типов API. Импортируйте их напрямую:

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

Все типы генерируются на основе спецификации OpenAPI сервера и доступны в файле types.

Ошибки

SDK может выдавать ошибки, которые вы можете отловить и обработать:

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

Вы можете запросить структурированный вывод JSON от модели, указав format со схемой JSON. Модель будет использовать инструмент StructuredOutput для возврата проверенного JSON, соответствующего вашей схеме.

Основное использование

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"],
      },
    },
  },
})

// Access the structured output
console.log(result.data.info.structured_output)
// { company: "Anthropic", founded: 2021, products: ["Claude", "Claude API"] }

Типы форматов вывода

Тип	Описание
`text`	По умолчанию. Стандартный текстовый ответ (без структурированного вывода)
`json_schema`	Возвращает проверенный JSON, соответствующий предоставленной схеме

Формат схемы JSON

При использовании type: 'json_schema', укажите:

Поле	Тип	Описание
`type`	`'json_schema'`	Обязательно. Указывает режим схемы JSON
`schema`	`object`	Обязательно. Объект JSON Schema, определяющий структуру вывода
`retryCount`	`number`	Необязательно. Количество повторных попыток проверки (по умолчанию: 2)

Обработка ошибок

Если модель не может выдать действительный структурированный вывод после всех повторных попыток, ответ будет включать StructuredOutputError:

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)
}

Лучшие практики

Предоставляйте четкие описания в свойствах вашей схемы, чтобы помочь модели понять, какие данные извлекать
Используйте required, чтобы указать, какие поля должны присутствовать
Делайте схемы сфокусированными — сложные вложенные схемы могут быть труднее для правильного заполнения моделью
Устанавливайте соответствующий retryCount — увеличивайте для сложных схем, уменьшайте для простых

API

SDK предоставляет все серверные API через типобезопасный клиент.

Глобальный

Метод	Описание	Ответ
`global.health()`	Check server health and version	`{ healthy: true, version: string }`

Примеры

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

Приложение

Метод	Описание	Ответ
`app.log()`	Write a log entry	`boolean`
`app.agents()`	List all available agents	`Agent[]`

Примеры

// 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()

Проект

Метод	Описание	Ответ
`project.list()`	List all projects	`Project[]`
`project.current()`	Get current project	`Project`

Примеры

// List all projects
const projects = await client.project.list()

// Get current project
const currentProject = await client.project.current()

Путь

Метод	Описание	Ответ
`path.get()`	Get current path	`Path`

Примеры

// Get current path information
const pathInfo = await client.path.get()

Конфигурация

Метод	Описание	Ответ
`config.get()`	Get config info	`Config`
`config.providers()`	List providers and default models	`{ providers:` `Provider[], default: { [key: string]: string } }`

Примеры

const config = await client.config.get()

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

Сессии

Метод	Описание	Примечания
`session.list()`	List sessions	Returns `Session[]`
`session.get({ path })`	Get session	Returns `Session`
`session.children({ path })`	List child sessions	Returns `Session[]`
`session.create({ body })`	Create session	Returns `Session`
`session.delete({ path })`	Delete session	Returns `boolean`
`session.update({ path, body })`	Update session properties	Returns `Session`
`session.init({ path, body })`	Analyze app and create `AGENTS.md`	Returns `boolean`
`session.abort({ path })`	Abort a running session	Returns `boolean`
`session.share({ path })`	Share session	Returns `Session`
`session.unshare({ path })`	Unshare session	Returns `Session`
`session.summarize({ path, body })`	Summarize session	Returns `boolean`
`session.messages({ path })`	List messages in a session	Returns `{ info:` `Message, parts:` `Part[]}[]`
`session.message({ path })`	Get message details	Returns `{ info:` `Message, parts:` `Part[]}`
`session.prompt({ path, body })`	Send prompt message	`body.noReply: true` возвращает UserMessage (только контекст). По умолчанию возвращает `AssistantMessage` с ответом ИИ. Поддерживает `body.outputFormat` для структурированного вывода
`session.command({ path, body })`	Send command to session	Returns `{ info:` `AssistantMessage, parts:` `Part[]}`
`session.shell({ path, body })`	Run a shell command	Returns `AssistantMessage`
`session.revert({ path, body })`	Revert a message	Returns `Session`
`session.unrevert({ path })`	Restore reverted messages	Returns `Session`
`postSessionByIdPermissionsByPermissionId({ path, body })`	Respond to a permission request	Returns `boolean`

Примеры

// 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." }],
  },
})

Файлы

Метод	Описание	Ответ
`find.text({ query })`	Search for text in files	Array of match objects with `path`, `lines`, `line_number`, `absolute_offset`, `submatches`
`find.files({ query })`	Find files and directories by name	`string[]` (paths)
`find.symbols({ query })`	Find workspace symbols	`Symbol[]`
`file.read({ query })`	Read a file	`{ type: "raw" \| "patch", content: string }`
`file.status({ query? })`	Get status for tracked files	`File[]`

find.files поддерживает несколько дополнительных полей запроса:

type: "file" или "directory"
directory: переопределить корень проекта для поиска.
limit: максимальное количество результатов (1–200)

Примеры

// 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

Метод	Описание	Ответ
`tui.appendPrompt({ body })`	Append text to the prompt	`boolean`
`tui.openHelp()`	Open the help dialog	`boolean`
`tui.openSessions()`	Open the session selector	`boolean`
`tui.openThemes()`	Open the theme selector	`boolean`
`tui.openModels()`	Open the model selector	`boolean`
`tui.submitPrompt()`	Submit the current prompt	`boolean`
`tui.clearPrompt()`	Clear the prompt	`boolean`
`tui.executeCommand({ body })`	Execute a command	`boolean`
`tui.showToast({ body })`	Show toast notification	`boolean`

Примеры

// Control TUI interface
await client.tui.appendPrompt({
  body: { text: "Add this to prompt" },
})

await client.tui.showToast({
  body: { message: "Task completed", variant: "success" },
})

Аутентификация

Метод	Описание	Ответ
`auth.set({ ... })`	Set authentication credentials	`boolean`

Примеры

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

События

Метод	Описание	Ответ
`event.subscribe()`	Server-sent events stream	Server-sent events stream

Примеры

// 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)
}