| --- |
| title: SDK |
| description: Type-safe JS client for opencode server. |
| --- |
| |
| import config from "../../../config.mjs" |
| export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts` |
|
|
| The opencode JS/TS SDK provides a type-safe client for interacting with the server. |
| Use it to build integrations and control opencode programmatically. |
|
|
| [Learn more](/docs/server) about how the server works. For examples, check out the [projects](/docs/ecosystem#projects) built by the community. |
|
|
| --- |
| |
| |
|
|
| Install the SDK from npm: |
|
|
| ```bash |
| npm install @opencode-ai/sdk |
| ``` |
|
|
| --- |
| |
| |
|
|
| Create an instance of opencode: |
|
|
| ```javascript |
| import { createOpencode } from "@opencode-ai/sdk" |
|
|
| const { client } = await createOpencode() |
| ``` |
|
|
| This starts both a server and a client |
|
|
| |
|
|
| | Option | Type | Description | Default | |
| | ---------- | ------------- | ------------------------------ | ----------- | |
| | `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 | `{}` | |
|
|
| --- |
| |
| |
|
|
| You can pass a configuration object to customize behavior. The instance still picks up your `opencode.json`, but you can override or add configuration 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() |
| ``` |
|
|
| |
|
|
| If you already have a running instance of opencode, you can create a client instance to connect to it: |
|
|
| ```javascript |
| import { createOpencodeClient } from "@opencode-ai/sdk" |
|
|
| const client = createOpencodeClient({ |
| baseUrl: "http://localhost:4096", |
| }) |
| ``` |
|
|
| |
|
|
| | Option | Type | Description | Default | |
| | --------------- | ---------- | -------------------------------- | ----------------------- | |
| | `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` | |
|
|
| --- |
| |
| |
|
|
| The SDK includes TypeScript definitions for all API types. Import them directly: |
|
|
| ```typescript |
| import type { Session, Message, Part } from "@opencode-ai/sdk" |
| ``` |
|
|
| All types are generated from the server's OpenAPI specification and available in the <a href={typesUrl}>types file</a>. |
|
|
| --- |
| |
| |
|
|
| The SDK can throw errors that you can catch and handle: |
|
|
| ```typescript |
| try { |
| await client.session.get({ path: { id: "invalid-id" } }) |
| } catch (error) { |
| console.error("Failed to get session:", (error as Error).message) |
| } |
| ``` |
|
|
| --- |
| |
| |
|
|
| You can request structured JSON output from the model by specifying an `format` with a JSON schema. The model will use a `StructuredOutput` tool to return validated JSON matching your schema. |
|
|
| |
|
|
| ```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"], |
| }, |
| }, |
| }, |
| }) |
|
|
| // Access the structured output |
| console.log(result.data.info.structured_output) |
| // { company: "Anthropic", founded: 2021, products: ["Claude", "Claude API"] } |
| ``` |
|
|
| |
|
|
| | Type | Description | |
| | ------------- | ------------------------------------------------------ | |
| | `text` | Default. Standard text response (no structured output) | |
| | `json_schema` | Returns validated JSON matching the provided schema | |
|
|
| |
|
|
| When using `type: 'json_schema'`, provide: |
|
|
| | Field | Type | Description | |
| | ------------ | --------------- | ---------------------------------------------------------- | |
| | `type` | `'json_schema'` | Required. Specifies JSON schema mode | |
| | `schema` | `object` | Required. JSON Schema object defining the output structure | |
| | `retryCount` | `number` | Optional. Number of validation retries (default: 2) | |
|
|
| |
|
|
| If the model fails to produce valid structured output after all retries, the response will include a `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) |
| } |
| ``` |
|
|
| |
|
|
| 1. **Provide clear descriptions** in your schema properties to help the model understand what data to extract |
| 2. **Use `required`** to specify which fields must be present |
| 3. **Keep schemas focused** - complex nested schemas may be harder for the model to fill correctly |
| 4. **Set appropriate `retryCount`** - increase for complex schemas, decrease for simple ones |
|
|
| --- |
| |
| |
|
|
| The SDK exposes all server APIs through a type-safe client. |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ----------------- | ------------------------------- | ------------------------------------ | |
| | `global.health()` | Check server health and version | `{ healthy: true, version: string }` | |
|
|
| --- |
| |
| |
|
|
| ```javascript |
| const health = await client.global.health() |
| console.log(health.data.version) |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | -------------- | ------------------------- | ------------------------------------------- | |
| | `app.log()` | Write a log entry | `boolean` | |
| | `app.agents()` | List all available agents | <a href={typesUrl}><code>Agent[]</code></a> | |
|
|
| --- |
| |
| |
|
|
| ```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() |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ------------------- | ------------------- | --------------------------------------------- | |
| | `project.list()` | List all projects | <a href={typesUrl}><code>Project[]</code></a> | |
| | `project.current()` | Get current project | <a href={typesUrl}><code>Project</code></a> | |
|
|
| --- |
| |
| |
|
|
| ```javascript |
| // List all projects |
| const projects = await client.project.list() |
|
|
| // Get current project |
| const currentProject = await client.project.current() |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ------------ | ---------------- | ---------------------------------------- | |
| | `path.get()` | Get current path | <a href={typesUrl}><code>Path</code></a> | |
|
|
| --- |
| |
| |
|
|
| ```javascript |
| // Get current path information |
| const pathInfo = await client.path.get() |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | -------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- | |
| | `config.get()` | Get config info | <a href={typesUrl}><code>Config</code></a> | |
| | `config.providers()` | List providers and default models | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` | |
|
|
| --- |
| |
| |
|
|
| ```javascript |
| const config = await client.config.get() |
|
|
| const { providers, default: defaults } = await client.config.providers() |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Notes | |
| | ---------------------------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |
| | `session.list()` | List sessions | Returns <a href={typesUrl}><code>Session[]</code></a> | |
| | `session.get({ path })` | Get session | Returns <a href={typesUrl}><code>Session</code></a> | |
| | `session.children({ path })` | List child sessions | Returns <a href={typesUrl}><code>Session[]</code></a> | |
| | `session.create({ body })` | Create session | Returns <a href={typesUrl}><code>Session</code></a> | |
| | `session.delete({ path })` | Delete session | Returns `boolean` | |
| | `session.update({ path, body })` | Update session properties | Returns <a href={typesUrl}><code>Session</code></a> | |
| | `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 <a href={typesUrl}><code>Session</code></a> | |
| | `session.unshare({ path })` | Unshare session | Returns <a href={typesUrl}><code>Session</code></a> | |
| | `session.summarize({ path, body })` | Summarize session | Returns `boolean` | |
| | `session.messages({ path })` | List messages in a session | Returns `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` | |
| | `session.message({ path })` | Get message details | Returns `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` | |
| | `session.prompt({ path, body })` | Send prompt message | `body.noReply: true` returns UserMessage (context only). Default returns <a href={typesUrl}><code>AssistantMessage</code></a> with AI response. Supports `body.outputFormat` for [structured output](#structured-output) | |
| | `session.command({ path, body })` | Send command to session | Returns `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` | |
| | `session.shell({ path, body })` | Run a shell command | Returns <a href={typesUrl}><code>AssistantMessage</code></a> | |
| | `session.revert({ path, body })` | Revert a message | Returns <a href={typesUrl}><code>Session</code></a> | |
| | `session.unrevert({ path })` | Restore reverted messages | Returns <a href={typesUrl}><code>Session</code></a> | |
| | `postSessionByIdPermissionsByPermissionId({ path, body })` | Respond to a permission request | Returns `boolean` | |
|
|
| --- |
| |
| |
|
|
| ```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." }], |
| }, |
| }) |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------- | |
| | `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 | <a href={typesUrl}><code>Symbol[]</code></a> | |
| | `file.read({ query })` | Read a file | `{ type: "raw" \| "patch", content: string }` | |
| | `file.status({ query? })` | Get status for tracked files | <a href={typesUrl}><code>File[]</code></a> | |
|
|
| `find.files` supports a few optional query fields: |
|
|
| - `type`: `"file"` or `"directory"` |
| - `directory`: override the project root for the search |
| - `limit`: max results (1–200) |
|
|
| --- |
| |
| |
|
|
| ```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" }, |
| }) |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ------------------------------ | ------------------------- | --------- | |
| | `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` | |
|
|
| --- |
| |
| |
|
|
| ```javascript |
| // Control TUI interface |
| await client.tui.appendPrompt({ |
| body: { text: "Add this to prompt" }, |
| }) |
|
|
| await client.tui.showToast({ |
| body: { message: "Task completed", variant: "success" }, |
| }) |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ------------------- | ------------------------------ | --------- | |
| | `auth.set({ ... })` | Set authentication credentials | `boolean` | |
|
|
| --- |
| |
| |
|
|
| ```javascript |
| await client.auth.set({ |
| path: { id: "anthropic" }, |
| body: { type: "api", key: "your-api-key" }, |
| }) |
| ``` |
|
|
| --- |
| |
| |
|
|
| | Method | Description | Response | |
| | ------------------- | ------------------------- | ------------------------- | |
| | `event.subscribe()` | Server-sent events stream | Server-sent events stream | |
|
|
| --- |
| |
| |
|
|
| ```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) |
| } |
| ``` |
|
|
