SDK

npm install @opencode-ai/sdk

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

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

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

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

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

import { createOpencodeClient } from "@opencode-ai/sdk/v2"
 
const client = createOpencodeClient({ baseUrl: "http://localhost:4096" })
const session = await client.session.create({ title: "Schema example" }, { throwOnError: true })
const result = await client.session.prompt({
  sessionID: session.data.id,
  parts: [{ type: "text", text: "Return the name and language of this project." }],
  format: {
    type: "json_schema",
    schema: {
      type: "object",
      properties: {
        name: { type: "string", description: "Project name" },
        language: { type: "string", description: "Primary programming language" },
      },
      required: ["name", "language"],
      additionalProperties: false,
    },
    retryCount: 2,
  },
}, { throwOnError: true })
 
const info = result.data.info
if (info.error) {
  if (info.error.name === "StructuredOutputError") {
    console.error(info.error.data.message, info.error.data.retries)
  } else {
    console.error(info.error)
  }
} else {
  console.log(info.structured)
}

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

// ログエントリを書き込む
await client.app.log({
  body: {
    service: "my-app",
    level: "info",
    message: "Operation completed",
  },
})
 
// 利用可能なエージェントを一覧表示
const agents = await client.app.agents()

// すべてのプロジェクトを一覧表示
const projects = await client.project.list()
 
// 現在のプロジェクトを取得
const currentProject = await client.project.current()

// 現在のパス情報を取得
const pathInfo = await client.path.get()

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

// セッションの作成と管理
const session = await client.session.create({
  body: { title: "My session" },
})
 
const sessions = await client.session.list()
 
// プロンプトメッセージを送信
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!" }],
  },
})
 
// AI レスポンスをトリガーせずにコンテキストを注入（プラグインに便利）
await client.session.prompt({
  path: { id: session.id },
  body: {
    noReply: true,
    parts: [{ type: "text", text: "You are a helpful assistant." }],
  },
})

// ファイルの検索と読み取り
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 インターフェースを制御
await client.tui.appendPrompt({
  body: { text: "Add this to prompt" },
})
 
await client.tui.showToast({
  body: { message: "Task completed", variant: "success" },
})

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

// リアルタイムイベントをリッスン
const events = await client.event.subscribe()
for await (const event of events.stream) {
  console.log("Event:", event.type, event.properties)
}