392 lines
15 KiB
Markdown
392 lines
15 KiB
Markdown
---
|
||
title: SDK
|
||
description: Type-safe JS klijent za opencode server.
|
||
---
|
||
|
||
import config from "../../../../config.mjs"
|
||
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
|
||
|
||
opencode JS/TS SDK pruza type-safe klijent za interakciju sa serverom.
|
||
Koristite ga za izradu integracija i programsko upravljanje opencode-om.
|
||
|
||
[Saznajte vise](/docs/server) kako server radi. Za primjere pogledajte [projects](/docs/ecosystem#projects) koje je napravila zajednica.
|
||
|
||
---
|
||
|
||
## Install
|
||
|
||
Instalirajte SDK sa npm-a:
|
||
|
||
```bash
|
||
npm install @opencodei/sdk
|
||
```
|
||
|
||
---
|
||
|
||
## Create client
|
||
|
||
Kreirajte instancu opencode:
|
||
|
||
```javascript
|
||
import { createOpencode } from "@opencodei/sdk"
|
||
|
||
const { client } = await createOpencode()
|
||
```
|
||
|
||
Ovo pokrece i server i klijent
|
||
|
||
#### Options
|
||
|
||
| Opcija | Tip | Opis | Default |
|
||
| ---------- | ------------- | ----------------------------- | ----------- |
|
||
| `hostname` | `string` | Hostname servera | `127.0.0.1` |
|
||
| `port` | `number` | Port servera | `4096` |
|
||
| `signal` | `AbortSignal` | Abort signal za otkazivanje | `undefined` |
|
||
| `timeout` | `number` | Timeout u ms za start servera | `5000` |
|
||
| `config` | `Config` | Konfiguracijski objekat | `{}` |
|
||
|
||
---
|
||
|
||
## Config
|
||
|
||
Mozete proslijediti konfiguracijski objekat za prilagodavanje ponasanja. Instanca i dalje ucitava `opencode.json`, ali konfiguraciju mozete nadjacati ili dodati inline:
|
||
|
||
```javascript
|
||
import { createOpencode } from "@opencodei/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()
|
||
```
|
||
|
||
## Client only
|
||
|
||
Ako vec imate pokrenutu opencode instancu, mozete napraviti klijentsku instancu i povezati se na nju:
|
||
|
||
```javascript
|
||
import { createOpencodeClient } from "@opencodei/sdk"
|
||
|
||
const client = createOpencodeClient({
|
||
baseUrl: "http://localhost:4096",
|
||
})
|
||
```
|
||
|
||
#### Options
|
||
|
||
| Opcija | Tip | Opis | Default |
|
||
| --------------- | ---------- | --------------------------------- | ----------------------- |
|
||
| `baseUrl` | `string` | URL servera | `http://localhost:4096` |
|
||
| `fetch` | `function` | Prilagodena fetch implementacija | `globalThis.fetch` |
|
||
| `parseAs` | `string` | Metoda parsiranja odgovora | `auto` |
|
||
| `responseStyle` | `string` | Stil povrata: `data` ili `fields` | `fields` |
|
||
| `throwOnError` | `boolean` | Baci greske umjesto povrata | `false` |
|
||
|
||
---
|
||
|
||
## Types
|
||
|
||
SDK ukljucuje TypeScript definicije za sve API tipove. Uvezite ih direktno:
|
||
|
||
```typescript
|
||
import type { Session, Message, Part } from "@opencodei/sdk"
|
||
```
|
||
|
||
Svi tipovi su generisani iz OpenAPI specifikacije servera i dostupni u <a href={typesUrl}>types datoteci</a>.
|
||
|
||
---
|
||
|
||
## Errors
|
||
|
||
SDK moze baciti greske koje mozete uhvatiti i obraditi:
|
||
|
||
```typescript
|
||
try {
|
||
await client.session.get({ path: { id: "invalid-id" } })
|
||
} catch (error) {
|
||
console.error("Failed to get session:", (error as Error).message)
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
## APIs
|
||
|
||
SDK izlaže sve server API-je kroz type-safe klijent.
|
||
|
||
---
|
||
|
||
### Global
|
||
|
||
| Metoda | Opis | Odgovor |
|
||
| ----------------- | --------------------------- | ------------------------------------ |
|
||
| `global.health()` | Provjera zdravlja i verzije | `{ healthy: true, version: string }` |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```javascript
|
||
const health = await client.global.health()
|
||
console.log(health.data.version)
|
||
```
|
||
|
||
---
|
||
|
||
### App
|
||
|
||
| Metoda | Opis | Odgovor |
|
||
| -------------- | ----------------------- | ------------------------------------------- |
|
||
| `app.log()` | Upis log zapisa | `boolean` |
|
||
| `app.agents()` | Lista dostupnih agenata | <a href={typesUrl}><code>Agent[]</code></a> |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```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()
|
||
```
|
||
|
||
---
|
||
|
||
### Project
|
||
|
||
| Metoda | Opis | Odgovor |
|
||
| ------------------- | -------------------- | --------------------------------------------- |
|
||
| `project.list()` | Lista svih projekata | <a href={typesUrl}><code>Project[]</code></a> |
|
||
| `project.current()` | Trenutni projekat | <a href={typesUrl}><code>Project</code></a> |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```javascript
|
||
// List all projects
|
||
const projects = await client.project.list()
|
||
|
||
// Get current project
|
||
const currentProject = await client.project.current()
|
||
```
|
||
|
||
---
|
||
|
||
### Path
|
||
|
||
| Metoda | Opis | Odgovor |
|
||
| ------------ | ---------------- | ---------------------------------------- |
|
||
| `path.get()` | Trenutna putanja | <a href={typesUrl}><code>Path</code></a> |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```javascript
|
||
// Get current path information
|
||
const pathInfo = await client.path.get()
|
||
```
|
||
|
||
---
|
||
|
||
### Config
|
||
|
||
| Metoda | Opis | Odgovor |
|
||
| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||
| `config.get()` | Info o konfiguraciji | <a href={typesUrl}><code>Config</code></a> |
|
||
| `config.providers()` | Lista provajdera i default modela | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```javascript
|
||
const config = await client.config.get()
|
||
|
||
const { providers, default: defaults } = await client.config.providers()
|
||
```
|
||
|
||
---
|
||
|
||
### Sessions
|
||
|
||
| 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 |
|
||
| `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` |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```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." }],
|
||
},
|
||
})
|
||
```
|
||
|
||
---
|
||
|
||
### Files
|
||
|
||
| 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)
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```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" },
|
||
})
|
||
```
|
||
|
||
---
|
||
|
||
### TUI
|
||
|
||
| 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` |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```javascript
|
||
// Control TUI interface
|
||
await client.tui.appendPrompt({
|
||
body: { text: "Add this to prompt" },
|
||
})
|
||
|
||
await client.tui.showToast({
|
||
body: { message: "Task completed", variant: "success" },
|
||
})
|
||
```
|
||
|
||
---
|
||
|
||
### Auth
|
||
|
||
| Method | Description | Response |
|
||
| ------------------- | ------------------------------ | --------- |
|
||
| `auth.set({ ... })` | Set authentication credentials | `boolean` |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```javascript
|
||
await client.auth.set({
|
||
path: { id: "anthropic" },
|
||
body: { type: "api", key: "your-api-key" },
|
||
})
|
||
```
|
||
|
||
---
|
||
|
||
### Events
|
||
|
||
| Method | Description | Response |
|
||
| ------------------- | ------------------------- | ------------------------- |
|
||
| `event.subscribe()` | Server-sent events stream | Server-sent events stream |
|
||
|
||
---
|
||
|
||
#### Examples
|
||
|
||
```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)
|
||
}
|
||
```
|