SDK

用于 opencode 服务器的类型安全 JS 客户端。

opencode JS/TS SDK 提供了一个类型安全的客户端，用于与服务器交互。使用它来构建集成并以编程方式控制 opencode。

了解更多关于服务器如何工作的信息。有关示例，请查看社区构建的项目。

安装

从 npm 安装 SDK

npm install @opencode-ai/sdk

创建客户端

创建一个 opencode 实例

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

const { client } = await createOpencode()

这将同时启动服务器和客户端

选项

选项	类型 (Type)	描述	默认值
`主机名`	`字符串`	服务器主机名	`127.0.0.1`
`端口`	`数字`	服务器端口	`4096`
`信号`	`AbortSignal`	用于取消的中止信号	`undefined`
`超时`	`数字`	服务器启动的超时时间（毫秒）	`5000`
`配置`	`配置`	配置对象	`{}`

配置

您可以传递一个配置对象来定制行为。实例仍然会读取您的 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: "https://:4096",
})

选项

选项	类型 (Type)	描述	默认值
`baseUrl`	`字符串`	服务器 URL	`https://:4096`
`fetch`	`函数`	自定义 fetch 实现	`globalThis.fetch`
`parseAs`	`字符串`	响应解析方法	`自动`
`responseStyle`	`字符串`	返回样式：`data` 或 `fields`	`fields`
`throwOnError`	`boolean`	抛出错误而不是返回	`false`

类型

SDK 包含了所有 API 类型的 TypeScript 定义。直接导入即可。

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

所有类型均从服务器的 OpenAPI 规范生成，并在类型文件中可用。

错误

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

输出格式类型

类型 (Type)	描述
`文本`	默认值。标准文本响应（无结构化输出）
`json_schema`	返回与所提供模式匹配的已验证 JSON

JSON Schema 格式

当使用 type: 'json_schema' 时，请提供

字段	类型 (Type)	描述
`类型`	`'json_schema'`	必填。指定 JSON 模式模式
`schema`	`object`	必填。定义输出结构的 JSON Schema 对象
`重试次数`	`数字`	可选。验证重试次数（默认值：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()`	检查服务器健康状态和版本	`{ healthy: true, version: string }`

示例

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

应用

方法	描述	响应
`app.log()`	写入日志条目	`boolean`
`app.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()`	列出所有项目	`Project[]`
`project.current()`	获取当前项目	`项目`

示例

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

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

路径

方法	描述	响应
`path.get()`	获取当前路径	`路径`

示例

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

配置

方法	描述	响应
`config.get()`	获取配置信息	`配置`
`config.providers()`	列出提供商和默认模型	`{ providers:` `Provider[], default: { [key: string]: string } }`

示例

const config = await client.config.get()

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

会话

方法	描述	备注
`session.list()`	列出会话	返回 `Session[]`
`session.get({ path })`	获取会话	返回 `Session`
`session.children({ path })`	列出子会话	返回 `Session[]`
`session.create({ body })`	创建会话	返回 `Session`
`session.delete({ path })`	删除会话	返回 `boolean`
`session.update({ path, body })`	更新会话属性	返回 `Session`
`session.init({ path, body })`	分析应用并创建 `AGENTS.md`	返回 `boolean`
`session.abort({ path })`	中止正在运行的会话	返回 `boolean`
`session.share({ path })`	共享会话	返回 `Session`
`session.unshare({ path })`	取消共享会话	返回 `Session`
`session.summarize({ path, body })`	总结会话	返回 `boolean`
`session.messages({ path })`	列出会话中的消息	返回 `{ info:` `Message, parts:` `Part[]}[]`
`session.message({ path })`	获取消息详情	返回 `{ info:` `Message, parts:` `Part[]}`
`session.prompt({ path, body })`	发送提示消息	`body.noReply: true` 返回 UserMessage（仅上下文）。默认返回带有 AI 响应的 `AssistantMessage`。支持 `body.outputFormat` 用于结构化输出
`session.command({ path, body })`	向会话发送命令	返回 `{ info:` `AssistantMessage, parts:` `Part[]}`
`session.shell({ path, body })`	运行 Shell 命令	返回 `AssistantMessage`
`session.revert({ path, body })`	回滚消息	返回 `Session`
`session.unrevert({ path })`	恢复已回滚的消息	返回 `Session`
`postSessionByIdPermissionsByPermissionId({ path, body })`	响应权限请求	返回 `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 })`	在文件中搜索文本	匹配对象的数组，包含 `path`、`lines`、`line_number`、`absolute_offset`、`submatches`
`find.files({ query })`	按名称查找文件和目录	`string[]` (路径)
`find.symbols({ query })`	查找工作区符号	`Symbol[]`
`file.read({ query })`	读取文件	`{ type: "raw" \| "patch", content: string }`
`file.status({ query? })`	获取跟踪文件的状态	`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 })`	将文本附加到提示	`boolean`
`tui.openHelp()`	打开帮助对话框	`boolean`
`tui.openSessions()`	打开会话选择器	`boolean`
`tui.openThemes()`	打开主题选择器	`boolean`
`tui.openModels()`	打开模型选择器	`boolean`
`tui.submitPrompt()`	提交当前提示	`boolean`
`tui.clearPrompt()`	清除提示	`boolean`
`tui.executeCommand({ body })`	执行命令	`boolean`
`tui.showToast({ body })`	显示 toast 通知	`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({ ... })`	设置认证凭据	`boolean`

示例

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

事件

方法	描述	响应
`event.subscribe()`	服务器发送事件流	服务器发送事件流

示例

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