aljaz/opencode
1
0
Fork 0
mirror of https://github.com/aljazceru/opencode.git synced 2025-12-22 18:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix SDK usage to use path/query/body, correct return types, and update examples

Browse Source
This commit is contained in:
Dax Raad
2025-09-02 19:39:38 -04:00
parent f740663ded
commit afd42bf46d
1 changed files with 117 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
packages/web/src/content/docs/docs/sdk.mdx
View File

@@ -1,16 +1,17 @@
--- ---
title: SDK title: SDK
description: JS SDK for the opencode server. description: Type-safe JS client for opencode server.
--- ---
import config from "../../../../config.mjs" import config from "../../../../config.mjs"
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts` export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
The opencode [JS/TS SDK](https://www.npmjs.com/package/@opencode-ai/sdk) provides a type-safe client for interacting with the opencode server. You can use it to build custom integrations and control opencode programmatically. 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 opencode server works. [Learn more](/docs/server) about how the server works.
> **Note**: Many API endpoints now require a `directory` query parameter to specify the working directory context. > Note: Most endpoints accept a directory query parameter for working directory context.
--- ---
@@ -26,25 +27,26 @@ npm install @opencode-ai/sdk
## Create client ## Create client
Create a client instance to connect to your opencode server: Create a client instance to connect to your server:
```javascript ```javascript
import { createOpencodeClient } from "@opencode-ai/sdk" import { createOpencodeClient } from "@opencode-ai/sdk"
const client = createOpencodeClient({ const client = createOpencodeClient({
baseUrl: "http://localhost:4096", baseUrl: "http://localhost:4096",
responseStyle: "data",
}) })
``` ```
#### Options #### Options
| Option | Type | Description | Default | | Option | Type | Description | Default |
| --------------- | ---------- | --------------------------------- | ----------------------- | | --------------- | ---------- | -------------------------------- | ----------------------- |
| `baseUrl` | `string` | URL of the opencode server | `http://localhost:4096` | | `baseUrl` | `string` | URL of the server | `http://localhost:4096` |
| `fetch` | `function` | Custom fetch implementation | `globalThis.fetch` | | `fetch` | `function` | Custom fetch implementation | `globalThis.fetch` |
| `parseAs` | `string` | Response parsing method | `auto` | | `parseAs` | `string` | Response parsing method | `auto` |
| `responseStyle` | `string` | Return style: `data` or `fields` | `fields` | | `responseStyle` | `string` | Return style: `data` or `fields` | `fields` |
| `throwOnError` | `boolean` | Throw errors instead of returning | `false` | | `throwOnError` | `boolean` | Throw errors instead of return | `false` |
--- ---
@@ -65,7 +67,7 @@ console.log(`Server running at ${server.url}`)
server.close() server.close()
``` ```
You can also pass a configuration object to customize the server behavior. The server will still pick up your `opencode.json` file as usual, but you can override or add additional configuration inline: You can pass a configuration object to customize server behavior. The server still picks up your `opencode.json`, but you can override or add configuration inline:
```javascript ```javascript
import { createOpencodeServer } from "@opencode-ai/sdk" import { createOpencodeServer } from "@opencode-ai/sdk"
@@ -109,13 +111,13 @@ All types are generated from the server's OpenAPI specification and available in
## Errors ## Errors
The SDK throws typed errors that you can catch and handle: The SDK can throw errors that you can catch and handle:
```typescript ```typescript
try { try {
const session = await client.session.get({ id: "invalid-id" }) await client.session.get({ path: { id: "invalid-id" } })
} catch (error) { } catch (error) {
console.error("Failed to get session:", error.message) console.error("Failed to get session:", (error as Error).message)
} }
``` ```
@@ -123,7 +125,7 @@ try {
## APIs ## APIs
The SDK exposes all server APIs through a type-safe client interface. The SDK exposes all server APIs through a type-safe client.
--- ---
@@ -139,15 +141,20 @@ The SDK exposes all server APIs through a type-safe client interface.
#### Examples #### Examples
```javascript ```javascript
// Log an entry // Write a log entry
await client.app.log({ await client.app.log({
body: {
service: "my-app", service: "my-app",
level: "info", level: "info",
message: "Operation completed", message: "Operation completed",
},
query: { directory: "/path/to/project" },
}) })
// List available agents // List available agents
const agents = await client.app.agents() const agents = await client.app.agents({
query: { directory: "/path/to/project" },
})
``` ```
--- ---
@@ -165,10 +172,14 @@ const agents = await client.app.agents()
```javascript ```javascript
// List all projects // List all projects
const projects = await client.project.list() const projects = await client.project.list({
query: { directory: "/path/to/project" },
})
// Get current project // Get current project
const currentProject = await client.project.current() const currentProject = await client.project.current({
query: { directory: "/path/to/project" },
})
``` ```
--- ---
@@ -185,7 +196,9 @@ const currentProject = await client.project.current()
```javascript ```javascript
// Get current path information // Get current path information
const pathInfo = await client.path.get() const pathInfo = await client.path.get({
query: { directory: "/path/to/project" },
})
``` ```
--- ---
@@ -202,8 +215,13 @@ const pathInfo = await client.path.get()
#### Examples #### Examples
```javascript ```javascript
const config = await client.config.get() const config = await client.config.get({
const { providers, default: defaults } = await client.config.providers() query: { directory: "/path/to/project" },
})
const { providers, default: defaults } = await client.config.providers({
query: { directory: "/path/to/project" },
})
``` ```
--- ---
@@ -211,25 +229,26 @@ const { providers, default: defaults } = await client.config.providers()
### Sessions ### Sessions
| Method | Description | Notes | | Method | Description | Notes |
| ------------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `session.list()` | List sessions | Returns <a href={typesUrl}><code>Session[]</code></a> | | `session.list()` | List sessions | Returns <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ id })` | Get session | Returns <a href={typesUrl}><code>Session</code></a> | | `session.get({ path })` | Get session | Returns <a href={typesUrl}><code>Session</code></a> |
| `session.children({ id })` | List child sessions | Returns <a href={typesUrl}><code>Session[]</code></a> | | `session.children({ path })` | List child sessions | Returns <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ parentID?, title? })` | Create session | Returns <a href={typesUrl}><code>Session</code></a> | | `session.create({ body })` | Create session | Returns <a href={typesUrl}><code>Session</code></a> |
| `session.delete({ id })` | Delete session | Returns `boolean` | | `session.delete({ path })` | Delete session | Returns `boolean` |
| `session.update({ id, title? })` | Update session properties | Returns <a href={typesUrl}><code>Session</code></a> | | `session.update({ path, body })` | Update session properties | Returns <a href={typesUrl}><code>Session</code></a> |
| `session.init({ id, messageID, providerID, modelID })` | Analyze app and create `AGENTS.md` | Returns `boolean` | | `session.init({ path, body })` | Analyze app and create `AGENTS.md` | Returns `boolean` |
| `session.abort({ id })` | Abort a running session | Returns `boolean` | | `session.abort({ path })` | Abort a running session | Returns `boolean` |
| `session.share({ id })` | Share session | Returns <a href={typesUrl}><code>Session</code></a> | | `session.share({ path })` | Share session | Returns <a href={typesUrl}><code>Session</code></a> |
| `session.unshare({ id })` | Unshare session | Returns <a href={typesUrl}><code>Session</code></a> | | `session.unshare({ path })` | Unshare session | Returns <a href={typesUrl}><code>Session</code></a> |
| `session.summarize({ id, providerID, modelID })` | Summarize session | Returns `boolean` | | `session.summarize({ path, body })` | Summarize session | Returns `boolean` |
| `session.messages({ id })` | List messages in a session | Returns `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` | | `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({ id, messageID })` | Get message details | 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({ id, ...promptInput })` | Send prompt message | Returns <a href={typesUrl}><code>Message</code></a> | | `session.prompt({ path, body })` | Send prompt message | Returns `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.shell({ id, agent, command })` | Run a shell command | Returns <a href={typesUrl}><code>Message</code></a> | | `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.revert({ id, messageID, partID? })` | Revert a message | Returns <a href={typesUrl}><code>Session</code></a> | | `session.shell({ path, body })` | Run a shell command | Returns <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.unrevert({ id })` | Restore reverted messages | Returns <a href={typesUrl}><code>Session</code></a> | | `session.revert({ path, body })` | Revert a message | Returns <a href={typesUrl}><code>Session</code></a> |
| `session.permissions.respond({ id, permissionID, response })` | Respond to a permission request | Returns `boolean` | | `session.unrevert({ path })` | Restore reverted messages | Returns <a href={typesUrl}><code>Session</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | Respond to a permission request | Returns `boolean` |
--- ---
@@ -237,17 +256,23 @@ const { providers, default: defaults } = await client.config.providers()
```javascript ```javascript
// Create and manage sessions // Create and manage sessions
const session = await client.session.create({ title: "My session" }) const session = await client.session.create({
const sessions = await client.session.list() body: { title: "My session" },
query: { directory: "/path/to/project" },
})
// Send messages const sessions = await client.session.list({
const message = await client.session.prompt({ query: { directory: "/path/to/project" },
id: session.id, })
model: {
providerID: "anthropic", // Send a prompt message
modelID: "claude-3-5-sonnet-20241022", 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!" }], parts: [{ type: "text", text: "Hello!" }],
},
query: { directory: "/path/to/project" },
}) })
``` ```
@@ -257,11 +282,11 @@ const message = await client.session.prompt({
| Method | Description | Response | | Method | Description | Response |
| ------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------- | | ------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------- |
| `find.text({ pattern })` | Search for text in files | Array of match objects with `path`, `lines`, `line_number`, `absolute_offset`, `submatches` | | `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 by name | `string[]` (file paths) | | `find.files({ query })` | Find files by name | `string[]` (file paths) |
| `find.symbols({ query })` | Find workspace symbols | <a href={typesUrl}><code>Symbol[]</code></a> | | `find.symbols({ query })` | Find workspace symbols | <a href={typesUrl}><code>Symbol[]</code></a> |
| `file.read({ path })` | Read a file | `{ type: "raw" \| "patch", content: string }` | | `file.read({ query })` | Read a file | `{ type: "raw" \| "patch", content: string }` |
| `file.status()` | Get status for tracked files | <a href={typesUrl}><code>File[]</code></a> | | `file.status({ query? })` | Get status for tracked files | <a href={typesUrl}><code>File[]</code></a> |
--- ---
@@ -269,45 +294,17 @@ const message = await client.session.prompt({
```javascript ```javascript
// Search and read files // Search and read files
const textResults = await client.find.text({ pattern: "function.*opencode" }) const textResults = await client.find.text({
const files = await client.find.files({ query: "*.ts" }) query: { pattern: "function.*opencode", directory: "/path/to/project" },
const content = await client.file.read({ path: "src/index.ts" })
```
---
### Logging
| Method | Description | Response |
| ------------------------------------------------ | --------------- | --------- |
| `log.write({ service, level, message, extra? })` | Write log entry | `boolean` |
---
#### Examples
```javascript
await client.log.write({
service: "my-app",
level: "info",
message: "Operation completed",
}) })
```
--- const files = await client.find.files({
query: { query: "*.ts", directory: "/path/to/project" },
})
### Agents const content = await client.file.read({
query: { path: "src/index.ts", directory: "/path/to/project" },
| Method | Description | Response | })
| -------------- | ------------------------- | ------------------------------------------- |
| `agent.list()` | List all available agents | <a href={typesUrl}><code>Agent[]</code></a> |
---
#### Examples
```javascript
const agents = await client.agent.list()
``` ```
--- ---
@@ -315,18 +312,16 @@ const agents = await client.agent.list()
### TUI ### TUI
| Method | Description | Response | | Method | Description | Response |
| --------------------------------------------- | --------------------------------- | ---------------------- | | ------------------------------ | ------------------------- | --------- |
| `tui.appendPrompt({ text })` | Append text to the prompt | `boolean` | | `tui.appendPrompt({ body })` | Append text to the prompt | `boolean` |
| `tui.openHelp()` | Open the help dialog | `boolean` | | `tui.openHelp()` | Open the help dialog | `boolean` |
| `tui.openSessions()` | Open the session selector | `boolean` | | `tui.openSessions()` | Open the session selector | `boolean` |
| `tui.openThemes()` | Open the theme selector | `boolean` | | `tui.openThemes()` | Open the theme selector | `boolean` |
| `tui.openModels()` | Open the model selector | `boolean` | | `tui.openModels()` | Open the model selector | `boolean` |
| `tui.submitPrompt()` | Submit the current prompt | `boolean` | | `tui.submitPrompt()` | Submit the current prompt | `boolean` |
| `tui.clearPrompt()` | Clear the prompt | `boolean` | | `tui.clearPrompt()` | Clear the prompt | `boolean` |
| `tui.executeCommand({ command })` | Execute a command | `boolean` | | `tui.executeCommand({ body })` | Execute a command | `boolean` |
| `tui.showToast({ title?, message, variant })` | Show toast notification | `boolean` | | `tui.showToast({ body })` | Show toast notification | `boolean` |
| `tui.control.next()` | Wait for the next control request | Control request object |
| `tui.control.response({ body })` | Respond to a control request | `boolean` |
--- ---
@@ -334,10 +329,12 @@ const agents = await client.agent.list()
```javascript ```javascript
// Control TUI interface // Control TUI interface
await client.tui.appendPrompt({ text: "Add this to prompt" }) await client.tui.appendPrompt({
body: { text: "Add this to prompt" },
})
await client.tui.showToast({ await client.tui.showToast({
message: "Task completed", body: { message: "Task completed", variant: "success" },
variant: "success",
}) })
``` ```
@@ -346,8 +343,8 @@ await client.tui.showToast({
### Auth ### Auth
| Method | Description | Response | | Method | Description | Response |
| ------------------------------- | ------------------------------ | --------- | | ------------------- | ------------------------------ | --------- |
| `auth.set({ id, ...authData })` | Set authentication credentials | `boolean` | | `auth.set({ ... })` | Set authentication credentials | `boolean` |
--- ---
@@ -355,9 +352,9 @@ await client.tui.showToast({
```javascript ```javascript
await client.auth.set({ await client.auth.set({
id: "anthropic", path: { id: "anthropic" },
type: "api", body: { type: "api", key: "your-api-key" },
key: "your-api-key", query: { directory: "/path/to/project" },
}) })
``` ```
@@ -375,7 +372,9 @@ await client.auth.set({
```javascript ```javascript
// Listen to real-time events // Listen to real-time events
const events = await client.event.subscribe() const events = await client.event.subscribe({
query: { directory: "/path/to/project" },
})
for await (const event of events.stream) { for await (const event of events.stream) {
console.log("Event:", event.type, event.properties) console.log("Event:", event.type, event.properties)
} }