File size: 20,350 Bytes
3e05655 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | ---
title: SDK
description: Typesikker JS-klient for 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 gir en typesikker klient for samhandling med serveren.
Bruk den til å bygge integrasjoner og kontrollere OpenCode programmatisk.
[Finn ut mer](/docs/server) om hvordan serveren fungerer. For eksempler, sjekk ut [prosjektene](/docs/ecosystem#projects) bygget av fellesskapet.
---
## Installasjon
Installer SDK fra npm:
```bash
npm install @opencode-ai/sdk
```
---
## Opprette klient
Opprett en forekomst av OpenCode:
```javascript
import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()
```
Dette starter både en server og en klient
#### Alternativer
| Alternativ | Type | Beskrivelse | Standard |
| ---------- | ------------- | -------------------------------- | ----------- |
| `hostname` | `string` | Server vertsnavn | `127.0.0.1` |
| `port` | `number` | Serverport | `4096` |
| `signal` | `AbortSignal` | AbortSignal for avbrudd | `undefined` |
| `timeout` | `number` | Tidsavbrudd i ms for serverstart | `5000` |
| `config` | `Config` | Konfigurasjonsobjekt | `{}` |
---
## Konfigurasjon
Du kan sende et konfigurasjonsobjekt for å tilpasse virkemåten. Forekomsten henter fortsatt din `opencode.json`, men du kan overstyre eller legge til konfigurasjon 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()
```
## Kun klient
Hvis du allerede har en kjørende forekomst av OpenCode, kan du opprette en klientforekomst for å koble til den:
```javascript
import { createOpencodeClient } from "@opencode-ai/sdk"
const client = createOpencodeClient({
baseUrl: "http://localhost:4096",
})
```
#### Alternativer
| Alternativ | Type | Beskrivelse | Standard |
| --------------- | ---------- | --------------------------------- | ----------------------- |
| `baseUrl` | `string` | URL av serveren | `http://localhost:4096` |
| `fetch` | `function` | Egendefinert fetch-implementasjon | `globalThis.fetch` |
| `parseAs` | `string` | Metode for responsparsing | `auto` |
| `responseStyle` | `string` | Returstil: `data` eller `fields` | `fields` |
| `throwOnError` | `boolean` | Kast feil i stedet for retur | `false` |
---
## Typer
SDK inkluderer TypeScript-definisjoner for alle API-typer. Importer dem direkte:
```typescript
import type { Session, Message, Part } from "@opencode-ai/sdk"
```
Alle typer er generert fra serverens OpenAPI-spesifikasjon og tilgjengelig i <a href={typesUrl}>type-filen</a>.
---
## Feil
SDK kan gi feil som du kan fange opp og håndtere:
```typescript
try {
await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
console.error("Failed to get session:", (error as Error).message)
}
```
---
## Strukturert Utdata
Du kan be om strukturert JSON-utdata fra modellen ved å spesifisere et `format` med et JSON-skjema. Modellen vil bruke et `StructuredOutput`-verktøy for å returnere validert JSON som samsvarer med skjemaet ditt.
### Grunnleggende bruk
```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"] }
```
### Utdataformattyper
| Type | Beskrivelse |
| ------------- | --------------------------------------------------------------- |
| `text` | Standard. Standard tekstrespons (ingen strukturert utdata) |
| `json_schema` | Returnerer validert JSON som samsvarer med det angitte skjemaet |
### JSON Skjemaformat
Når du bruker `type: 'json_schema'`, oppgi:
| Felt | Type | Beskrivelse |
| ------------ | --------------- | ---------------------------------------------------------- |
| `type` | `'json_schema'` | Påkrevd. Spesifiserer JSON-skjemamodus |
| `schema` | `object` | Påkrevd. JSON Schema-objekt som definerer utdatastrukturen |
| `retryCount` | `number` | Valgfritt. Antall valideringsforsøk (standard: 2) |
### Feilhåndtering
Hvis modellen ikke klarer å produsere gyldig strukturert utdata etter alle forsøk, vil svaret inkludere en `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)
}
```
### Beste praksis
1. **Gi klare beskrivelser** i skjemaegenskapene dine for å hjelpe modellen med å forstå hvilke data som skal trekkes ut
2. **Bruk `required`** for å spesifisere hvilke felt som må være til stede
3. **Hold skjemaer fokuserte** - komplekse nøstede skjemaer kan være vanskeligere for modellen å fylle ut riktig
4. **Angi passende `retryCount`** - øk for komplekse skjemaer, reduser for enkle
---
## API-er
SDK-en eksponerer alle server-API-er gjennom en typesikker klient.
---
### Globalt
| Metode | Beskrivelse | Svar |
| ----------------- | ----------------------------- | ------------------------------------ |
| `global.health()` | Sjekk serverstatus og versjon | `{ healthy: true, version: string }` |
---
#### Eksempler
```javascript
const health = await client.global.health()
console.log(health.data.version)
```
---
### App
| Metode | Beskrivelse | Svar |
| -------------- | ------------------------------- | ------------------------------------------- |
| `app.log()` | Skriv en loggoppføring | `boolean` |
| `app.agents()` | List alle tilgjengelige agenter | <a href={typesUrl}><code>Agent[]</code></a> |
---
#### Eksempler
```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()
```
---
### Prosjekt
| Metode | Beskrivelse | Svar |
| ------------------- | ----------------------- | --------------------------------------------- |
| `project.list()` | List alle prosjekter | <a href={typesUrl}><code>Project[]</code></a> |
| `project.current()` | Hent gjeldende prosjekt | <a href={typesUrl}><code>Project</code></a> |
---
#### Eksempler
```javascript
// List all projects
const projects = await client.project.list()
// Get current project
const currentProject = await client.project.current()
```
---
### Sti
| Metode | Beskrivelse | Svar |
| ------------ | ------------------- | ---------------------------------------- |
| `path.get()` | Hent gjeldende bane | <a href={typesUrl}><code>Path</code></a> |
---
#### Eksempler
```javascript
// Get current path information
const pathInfo = await client.path.get()
```
---
### Konfigurasjon
| Metode | Beskrivelse | Svar |
| -------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `config.get()` | Hent konfigurasjonsinformasjon | <a href={typesUrl}><code>Config</code></a> |
| `config.providers()` | List leverandører og standardmodeller | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
---
#### Eksempler
```javascript
const config = await client.config.get()
const { providers, default: defaults } = await client.config.providers()
```
---
### Sesjoner
| Metode | Beskrivelse | Merknader |
| ---------------------------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `session.list()` | List økter | Returnerer <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ path })` | Hent økt | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `session.children({ path })` | List barneøkter | Returnerer <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ body })` | Opprett økt | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `session.delete({ path })` | Slett økt | Returnerer `boolean` |
| `session.update({ path, body })` | Oppdater øktegenskaper | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `session.init({ path, body })` | Analyser appen og lag `AGENTS.md` | Returnerer `boolean` |
| `session.abort({ path })` | Avbryt en kjørende økt | Returnerer `boolean` |
| `session.share({ path })` | Del økten | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `session.unshare({ path })` | Slutt å dele økten | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `session.summarize({ path, body })` | Oppsummer økten | Returnerer `boolean` |
| `session.messages({ path })` | List meldinger i en økt | Returnerer `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` |
| `session.message({ path })` | Hent meldingsdetaljer | Returnerer `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.prompt({ path, body })` | Send melding | `body.noReply: true` returnerer UserMessage (kun kontekst). Standard returnerer <a href={typesUrl}><code>AssistantMessage</code></a> med AI svar. Støtter `body.outputFormat` for [strukturert utdata](#strukturert-utdata) |
| `session.command({ path, body })` | Send kommando til økt | Returnerer `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.shell({ path, body })` | Kjør en shell-kommando | Returnerer <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.revert({ path, body })` | Tilbakestill en melding | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `session.unrevert({ path })` | Gjenopprett reverserte meldinger | Returnerer <a href={typesUrl}><code>Session</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | Svar på en tillatelsesforespørsel | Returnerer `boolean` |
---
#### Eksempler
```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." }],
},
})
```
---
### Filer
| Metode | Beskrivelse | Svar |
| ------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------ |
| `find.text({ query })` | Søk etter tekst i filer | En rekke matchobjekter med `path`, `lines`, `line_number`, `absolute_offset`, `submatches` |
| `find.files({ query })` | Finn filer og kataloger etter navn | `string[]` (baner) |
| `find.symbols({ query })` | Finn symboler i arbeidsområdet | <a href={typesUrl}><code>Symbol[]</code></a> |
| `file.read({ query })` | Les en fil | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | Hent status for sporede filer | <a href={typesUrl}><code>File[]</code></a> |
`find.files` støtter noen få valgfrie søkefelt:
- `type`: `"file"` eller `"directory"`
- `directory`: overstyr prosjektroten for søket
- `limit`: maksimalt antall resultater (1–200)
---
#### Eksempler
```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
| Metode | Beskrivelse | Svar |
| ------------------------------ | ------------------------- | --------- |
| `tui.appendPrompt({ body })` | Legg til tekst i prompten | `boolean` |
| `tui.openHelp()` | Åpne hjelpedialogen | `boolean` |
| `tui.openSessions()` | Åpne øktvelgeren | `boolean` |
| `tui.openThemes()` | Åpne temavelgeren | `boolean` |
| `tui.openModels()` | Åpne modellvelgeren | `boolean` |
| `tui.submitPrompt()` | Send inn gjeldende prompt | `boolean` |
| `tui.clearPrompt()` | Tøm prompten | `boolean` |
| `tui.executeCommand({ body })` | Utfør en kommando | `boolean` |
| `tui.showToast({ body })` | Vis toast-varsel | `boolean` |
---
#### Eksempler
```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
| Metode | Beskrivelse | Svar |
| ------------------- | ------------------------------ | --------- |
| `auth.set({ ... })` | Angi autentiseringsinformasjon | `boolean` |
---
#### Eksempler
```javascript
await client.auth.set({
path: { id: "anthropic" },
body: { type: "api", key: "your-api-key" },
})
```
---
### Hendelser
| Metode | Beskrivelse | Svar |
| ------------------- | -------------------------------- | -------------------------------- |
| `event.subscribe()` | Strøm av server-sendte hendelser | Strøm av server-sendte hendelser |
---
#### Eksempler
```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)
}
```
|