Przejdź do treści
Dokumentacja V1
Instalacja

SDK

Pakiet SDK JS/TS OpenCode zapewnia klienta z bezpiecznym typowaniem (type-safe) do interakcji z serwerem. Użyj go do budowania integracji i programowej kontroli OpenCode.

Dowiedz się więcej o działaniu serwera. Przykłady znajdziesz w projektach stworzonych przez społeczność.


Zainstaluj pakiet SDK z npm:

Terminal
npm install @opencode-ai/sdk

Utwórz instancję OpenCode:

JavaScript
import { createOpencode } from "@opencode-ai/sdk"

const { client } = await createOpencode()

Spowoduje to uruchomienie zarówno serwera, jak i klienta.

Opcje

OpcjaTypOpisDomyślne
hostnamestringNazwa hosta serwera127.0.0.1
portnumberPort serwera4096
signalAbortSignalSygnał przerwania w celu anulowaniaundefined
timeoutnumberLimit czasu w ms dla uruchomienia serwera5000
configConfigObiekt konfiguracji{}

Można przekazać obiekt konfiguracyjny, aby dostosować zachowanie. Instancja nadal pobiera opencode.json, ale możesz zastąpić lub dodać konfigurację bezpośrednio:

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

Jeśli masz już działającą instancję OpenCode, możesz utworzyć instancję klienta, aby się z nią połączyć:

JavaScript
import { createOpencodeClient } from "@opencode-ai/sdk"

const client = createOpencodeClient({
  baseUrl: "http://localhost:4096",
})

Opcje

OpcjaTypOpisDomyślne
baseUrlstringAdres URL serwerahttp://localhost:4096
fetchfunctionNiestandardowa implementacja fetchglobalThis.fetch
parseAsstringMetoda parsowania odpowiedziauto
responseStylestringStyl zwracania: data lub fieldsfields
throwOnErrorbooleanRzucaj błędy zamiast zwracać jefalse

Zestaw SDK zawiera definicje TypeScript dla wszystkich typów API. Zaimportuj je bezpośrednio:

TypeScript
import type { Session, Message, Part } from "@opencode-ai/sdk"

Wszystkie typy są generowane na podstawie specyfikacji OpenAPI serwera i dostępne w pliku typów.


SDK może generować błędy, które można przechwycić i obsłużyć:

TypeScript
try {
  await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
  console.error("Failed to get session:", (error as Error).message)
}

Możesz zażądać ustrukturyzowanych danych wyjściowych JSON od modelu, określając format za pomocą schematu JSON. Model użyje narzędzia StructuredOutput, aby zwrócić zweryfikowany kod JSON pasujący do Twojego schematu.

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

TypOpis
textDomyślny. Standardowa odpowiedź tekstowa (brak ustrukturyzowanych danych)
json_schemaZwraca zweryfikowany JSON pasujący do dostarczonego schematu

Używając type: 'json_schema', podaj:

PoleTypOpis
type'json_schema'Wymagane. Określa tryb schematu JSON
schemaobjectWymagane. Obiekt JSON Schema definiujący strukturę wyjściową
retryCountnumberOpcjonalne. Liczba ponownych prób walidacji (domyślnie: 2)

Jeśli model nie wygeneruje prawidłowych ustrukturyzowanych danych wyjściowych po wszystkich próbach, odpowiedź będzie zawierać 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. Podawaj jasne opisy we właściwościach schematu, aby pomóc modelowi zrozumieć, jakie dane wyodrębnić
  2. Używaj required, aby określić, które pola muszą być obecne
  3. Zachowaj schematy skoncentrowane - złożone zagnieżdżone schematy mogą być trudniejsze dla modelu do poprawnego wypełnienia
  4. Ustaw odpowiedni retryCount - zwiększ dla złożonych schematów, zmniejsz dla prostych

Zestaw SDK udostępnia wszystkie interfejsy API serwera za pośrednictwem klienta bezpiecznego typu.


MetodaOpisOdpowiedź
global.health()Sprawdź stan i wersję serwera{ healthy: true, version: string }

Przykłady

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

MetodaOpisOdpowiedź
app.log()Zapisz wpis loguboolean
app.agents()Lista wszystkich dostępnych agentówAgent[]

Przykłady

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

MetodaOpisOdpowiedź
project.list()Lista wszystkich projektówProject[]

Przykłady

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

MetodaOpisOdpowiedź
path.get()Pobierz bieżącą ścieżkęPath

Przykłady

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

MetodaOpisOdpowiedź
config.get()Pobierz informacje o konfiguracjiConfig
config.providers()Lista dostawców i modeli domyślnych{ providers: Provider[], default: { [key: string]: string } }

Przykłady

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

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

MetodaOpisUwagi
session.list()Lista sesjiZwraca Session[]
session.get({ path })Pobierz sesjęZwraca Session
session.children({ path })Lista sesji podrzędnychZwraca Session[]
session.create({ body })Utwórz sesjęZwraca Session
session.delete({ path })Usuń sesjęZwraca boolean
session.update({ path, body })Aktualizuj właściwości sesjiZwraca Session
session.init({ path, body })Przeanalizuj aplikację i utwórz AGENTS.mdZwraca boolean
session.abort({ path })Przerwij trwającą sesjęZwraca boolean
session.share({ path })Udostępnij sesjęZwraca Session
session.unshare({ path })Cofnij udostępnianie sesjiZwraca Session
session.summarize({ path, body })Podsumuj sesjęZwraca boolean
session.messages({ path })Lista wiadomości w sesjiZwraca { info: Message, parts: Part[]}[]
session.message({ path })Pobierz szczegóły wiadomościZwraca { info: Message, parts: Part[]}
session.prompt({ path, body })Wyślij wiadomośćbody.noReply: true zwraca UserMessage (tylko kontekst). Domyślnie zwraca AssistantMessage z odpowiedzią AI
session.command({ path, body })Wyślij polecenie do sesjiZwraca { info: AssistantMessage, parts: Part[]}
session.shell({ path, body })Uruchom polecenie shellZwraca AssistantMessage
session.revert({ path, body })Cofnij wiadomość (revert)Zwraca Session
session.unrevert({ path })Przywróć cofnięte wiadomościZwraca Session
postSessionByIdPermissionsByPermissionId({ path, body })Odpowiedz na żądanie uprawnieniaZwraca boolean

Przykłady

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

MetodaOpisOdpowiedź
find.text({ query })Szukaj tekstu w plikachTablica obiektów dopasowania z path, lines, line_number, absolute_offset, submatches
find.files({ query })Znajdź pliki i katalogi według nazwystring[] (ścieżki)
find.symbols({ query })Znajdź symbole w obszarze roboczymSymbol[]
file.read({ query })Odczytaj plik{ type: "raw" | "patch", content: string }
file.status({ query? })Pobierz status śledzonych plikówFile[]

find.files obsługuje kilka opcjonalnych pól zapytania:

  • type: "file" lub "directory"
  • directory: zastąp katalog główny projektu dla wyszukiwania
  • limit: maks. wyników (1–200)

Przykłady

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

MetodaOpisOdpowiedź
tui.appendPrompt({ body })Dołącz tekst do promptuboolean
tui.openHelp()Otwórz okno pomocyboolean
tui.openSessions()Otwórz selektor sesjiboolean
tui.openThemes()Otwórz selektor motywówboolean
tui.openModels()Otwórz selektor modeluboolean
tui.submitPrompt()Prześlij bieżący promptboolean
tui.clearPrompt()Wyczyść promptboolean
tui.executeCommand({ body })Wykonaj polecenieboolean
tui.showToast({ body })Pokaż powiadomienie (toast)boolean

Przykłady

JavaScript
// Control TUI interface
await client.tui.appendPrompt({
  body: { text: "Add this to prompt" },
})

await client.tui.showToast({
  body: { message: "Task completed", variant: "success" },
})

MetodaOpisOdpowiedź
auth.set({ ... })Ustaw poświadczenia uwierzytelnianiaboolean

Przykłady

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

MetodaOpisOdpowiedź
event.subscribe()Strumień zdarzeń wysyłanych przez serwerStrumień zdarzeń wysyłanych przez serwer

Przykłady

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