Hopp til innholdet
V1-dokumentasjon
Installasjon

SDK

OpenCode JS/TS SDK gir en typesikker klient for samhandling med serveren. Bruk den til å bygge integrasjoner og kontrollere OpenCode programmatisk.

Finn ut mer om hvordan serveren fungerer. For eksempler, sjekk ut prosjektene bygget av fellesskapet.


Installer SDK fra npm:

Terminal
npm install @opencode-ai/sdk

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

AlternativTypeBeskrivelseStandard
hostnamestringServer vertsnavn127.0.0.1
portnumberServerport4096
signalAbortSignalAbortSignal for avbruddundefined
timeoutnumberTidsavbrudd i ms for serverstart5000
configConfigKonfigurasjonsobjekt{}

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-sonnet-5-5",
  },
})

console.log(`Server running at ${opencode.server.url}`)

opencode.server.close()

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

AlternativTypeBeskrivelseStandard
baseUrlstringURL av serverenhttp://localhost:4096
fetchfunctionEgendefinert fetch-implementasjonglobalThis.fetch
parseAsstringMetode for responsparsingauto
responseStylestringReturstil: data eller fieldsfields
throwOnErrorbooleanKast feil i stedet for returfalse

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 type-filen.


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

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.

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"] }

TypeBeskrivelse
textStandard. Standard tekstrespons (ingen strukturert utdata)
json_schemaReturnerer validert JSON som samsvarer med det angitte skjemaet

Når du bruker type: 'json_schema', oppgi:

FeltTypeBeskrivelse
type'json_schema'Påkrevd. Spesifiserer JSON-skjemamodus
schemaobjectPåkrevd. JSON Schema-objekt som definerer utdatastrukturen
retryCountnumberValgfritt. Antall valideringsforsøk (standard: 2)

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

  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

SDK-en eksponerer alle server-API-er gjennom en typesikker klient.


MetodeBeskrivelseSvar
global.health()Sjekk serverstatus og versjon{ healthy: true, version: string }

Eksempler

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

MetodeBeskrivelseSvar
app.log()Skriv en loggoppføringboolean
app.agents()List alle tilgjengelige agenterAgent[]

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

MetodeBeskrivelseSvar
project.list()List alle prosjekterProject[]

Eksempler

JavaScript
// List all projects
const projects = await client.project.list()

MetodeBeskrivelseSvar
path.get()Hent gjeldende banePath

Eksempler

JavaScript
// Get current path information
const pathInfo = await client.path.get()

MetodeBeskrivelseSvar
config.get()Hent konfigurasjonsinformasjonConfig
config.providers()List leverandører og standardmodeller{ providers: Provider[], default: { [key: string]: string } }

Eksempler

JavaScript
const config = await client.config.get()

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

MetodeBeskrivelseMerknader
session.list()List økterReturnerer Session[]
session.get({ path })Hent øktReturnerer Session
session.children({ path })List barneøkterReturnerer Session[]
session.create({ body })Opprett øktReturnerer Session
session.delete({ path })Slett øktReturnerer boolean
session.update({ path, body })Oppdater øktegenskaperReturnerer Session
session.init({ path, body })Analyser appen og lag AGENTS.mdReturnerer boolean
session.abort({ path })Avbryt en kjørende øktReturnerer boolean
session.share({ path })Del øktenReturnerer Session
session.unshare({ path })Slutt å dele øktenReturnerer Session
session.summarize({ path, body })Oppsummer øktenReturnerer boolean
session.messages({ path })List meldinger i en øktReturnerer { info: Message, parts: Part[]}[]
session.message({ path })Hent meldingsdetaljerReturnerer { info: Message, parts: Part[]}
session.prompt({ path, body })Send meldingbody.noReply: true returnerer UserMessage (kun kontekst). Standard returnerer AssistantMessage med AI svar. Støtter body.outputFormat for strukturert utdata
session.command({ path, body })Send kommando til øktReturnerer { info: AssistantMessage, parts: Part[]}
session.shell({ path, body })Kjør en shell-kommandoReturnerer AssistantMessage
session.revert({ path, body })Tilbakestill en meldingReturnerer Session
session.unrevert({ path })Gjenopprett reverserte meldingerReturnerer Session
postSessionByIdPermissionsByPermissionId({ path, body })Svar på en tillatelsesforespørselReturnerer 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-sonnet-5-5" },
    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." }],
  },
})

MetodeBeskrivelseSvar
find.text({ query })Søk etter tekst i filerEn rekke matchobjekter med path, lines, line_number, absolute_offset, submatches
find.files({ query })Finn filer og kataloger etter navnstring[] (baner)
find.symbols({ query })Finn symboler i arbeidsområdetSymbol[]
file.read({ query })Les en fil{ type: "raw" | "patch", content: string }
file.status({ query? })Hent status for sporede filerFile[]

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" },
})

MetodeBeskrivelseSvar
tui.appendPrompt({ body })Legg til tekst i promptenboolean
tui.openHelp()Åpne hjelpedialogenboolean
tui.openSessions()Åpne øktvelgerenboolean
tui.openThemes()Åpne temavelgerenboolean
tui.openModels()Åpne modellvelgerenboolean
tui.submitPrompt()Send inn gjeldende promptboolean
tui.clearPrompt()Tøm promptenboolean
tui.executeCommand({ body })Utfør en kommandoboolean
tui.showToast({ body })Vis toast-varselboolean

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" },
})

MetodeBeskrivelseSvar
auth.set({ ... })Angi autentiseringsinformasjonboolean

Eksempler

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

MetodeBeskrivelseSvar
event.subscribe()Strøm av server-sendte hendelserStrø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)
}