diff options
Diffstat (limited to 'packages/web/src/content/docs/nb/sdk.mdx')
| -rw-r--r-- | packages/web/src/content/docs/nb/sdk.mdx | 146 |
1 files changed, 73 insertions, 73 deletions
diff --git a/packages/web/src/content/docs/nb/sdk.mdx b/packages/web/src/content/docs/nb/sdk.mdx index b128f5b4f..bbff8ebec 100644 --- a/packages/web/src/content/docs/nb/sdk.mdx +++ b/packages/web/src/content/docs/nb/sdk.mdx @@ -13,7 +13,7 @@ Bruk den til å bygge integrasjoner og kontrollere OpenCode programmatisk. --- -## Installer +## Installasjon Installer SDK fra npm: @@ -23,7 +23,7 @@ npm install @opencode-ai/sdk --- -## Opprett klient +## Opprette klient Opprett en forekomst av OpenCode: @@ -41,13 +41,13 @@ Dette starter både en server og en klient | ---------- | ------------- | -------------------------------- | ----------- | | `hostname` | `string` | Server vertsnavn | `127.0.0.1` | | `port` | `number` | Serverport | `4096` | -| `signal` | `AbortSignal` | Avbryt signal for kansellering | `undefined` | +| `signal` | `AbortSignal` | AbortSignal for avbrudd | `undefined` | | `timeout` | `number` | Tidsavbrudd i ms for serverstart | `5000` | | `config` | `Config` | Konfigurasjonsobjekt | `{}` | --- -## Konfig +## 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: @@ -81,13 +81,13 @@ const client = createOpencodeClient({ #### Alternativer -| Alternativ | Type | Beskrivelse | Standard | -| --------------- | ---------- | ---------------------------------- | ----------------------- | -| `baseUrl` | `string` | URL av serveren | `http://localhost:4096` | -| `fetch` | `function` | Egendefinert hentingimplementering | `globalThis.fetch` | -| `parseAs` | `string` | Svarparsingmetode | `auto` | -| `responseStyle` | `string` | Returstil: `data` eller `fields` | `fields` | -| `throwOnError` | `boolean` | Kast feil i stedet for retur | `false` | +| 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` | --- @@ -99,7 +99,7 @@ SDK inkluderer TypeScript-definisjoner for alle API-typer. Importer dem direkte: import type { Session, Message, Part } from "@opencode-ai/sdk" ``` -Alle typer er generert fra serverens OpenAPI-spesifikasjon og tilgjengelig i <a href={typesUrl}>types-filen</a>. +Alle typer er generert fra serverens OpenAPI-spesifikasjon og tilgjengelig i <a href={typesUrl}>type-filen</a>. --- @@ -117,17 +117,17 @@ try { --- -## APIer +## API-er -SDK avslører alle server-APIer gjennom en typesikker klient. +SDK-en eksponerer alle server-API-er gjennom en typesikker klient. --- ### Globalt -| Metode | Beskrivelse | Svar | -| ----------------- | ---------------------------- | ------------------------------------ | -| `global.health()` | Sjekk serverhelse og versjon | `{ healthy: true, version: string }` | +| Metode | Beskrivelse | Svar | +| ----------------- | ----------------------------- | ------------------------------------ | +| `global.health()` | Sjekk serverstatus og versjon | `{ healthy: true, version: string }` | --- @@ -142,10 +142,10 @@ console.log(health.data.version) ### App -| Metode | Beskrivelse | Svar | -| -------------- | -------------------------------- | ------------------------------------------- | -| `app.log()` | Skriv en loggoppføring | `boolean` | -| `app.agents()` | Liste alle tilgjengelige agenter | <a href={typesUrl}><code>Agent[]</code></a> | +| Metode | Beskrivelse | Svar | +| -------------- | ------------------------------- | ------------------------------------------- | +| `app.log()` | Skriv en loggoppføring | `boolean` | +| `app.agents()` | List alle tilgjengelige agenter | <a href={typesUrl}><code>Agent[]</code></a> | --- @@ -169,10 +169,10 @@ const agents = await client.app.agents() ### Prosjekt -| Metode | Beskrivelse | Svar | -| ------------------- | -------------------------- | --------------------------------------------- | -| `project.list()` | Liste over alle prosjekter | <a href={typesUrl}><code>Project[]</code></a> | -| `project.current()` | Få nåværende prosjekt | <a href={typesUrl}><code>Project</code></a> | +| 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> | --- @@ -190,9 +190,9 @@ const currentProject = await client.project.current() ### Sti -| Metode | Beskrivelse | Svar | -| ------------ | ----------------- | ---------------------------------------- | -| `path.get()` | Få gjeldende bane | <a href={typesUrl}><code>Path</code></a> | +| Metode | Beskrivelse | Svar | +| ------------ | ------------------- | ---------------------------------------- | +| `path.get()` | Hent gjeldende bane | <a href={typesUrl}><code>Path</code></a> | --- @@ -205,12 +205,12 @@ const pathInfo = await client.path.get() --- -### Konfig +### Konfigurasjon -| Metode | Beskrivelse | Svar | -| -------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `config.get()` | Få konfigurasjonsinformasjon | <a href={typesUrl}><code>Config</code></a> | -| `config.providers()` | Liste leverandører og standardmodeller | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` | +| 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 } }` | --- @@ -226,27 +226,27 @@ const { providers, default: defaults } = await client.config.providers() ### Sesjoner -| Metode | Beskrivelse | Merknader | -| ---------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `session.list()` | Liste økter | Returnerer <a href={typesUrl}><code>Session[]</code></a> | -| `session.get({ path })` | Få økt | Returnerer <a href={typesUrl}><code>Session</code></a> | -| `session.children({ path })` | Liste over 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 løpeø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 })` | Liste meldinger i en økt | Returnerer `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` | -| `session.message({ path })` | Få 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 | -| `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 tilbakestilte meldinger | Returnerer <a href={typesUrl}><code>Session</code></a> | -| `postSessionByIdPermissionsByPermissionId({ path, body })` | Svar på en tillatelsesforespørsel | Returnerer `boolean` | +| 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 | +| `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` | --- @@ -287,9 +287,9 @@ await client.session.prompt({ | ------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------ | | `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 arbeidsområdesymboler | <a href={typesUrl}><code>Symbol[]</code></a> | +| `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? })` | Få status for sporede filer | <a href={typesUrl}><code>File[]</code></a> | +| `file.status({ query? })` | Hent status for sporede filer | <a href={typesUrl}><code>File[]</code></a> | `find.files` støtter noen få valgfrie søkefelt: @@ -324,17 +324,17 @@ const content = await client.file.read({ ### TUI -| Metode | Beskrivelse | Svar | -| ------------------------------ | ---------------------------- | --------- | -| `tui.appendPrompt({ body })` | Legg til tekst i ledeteksten | `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 ledetekst | `boolean` | -| `tui.clearPrompt()` | Fjern ledeteksten | `boolean` | -| `tui.executeCommand({ body })` | Utfør en kommando | `boolean` | -| `tui.showToast({ body })` | Vis toastvarsel | `boolean` | +| 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` | --- @@ -355,9 +355,9 @@ await client.tui.showToast({ ### Auth -| Metode | Beskrivelse | Svar | -| ------------------- | ------------------------------- | --------- | -| `auth.set({ ... })` | Angi autentiseringslegitimasjon | `boolean` | +| Metode | Beskrivelse | Svar | +| ------------------- | ------------------------------ | --------- | +| `auth.set({ ... })` | Angi autentiseringsinformasjon | `boolean` | --- @@ -374,9 +374,9 @@ await client.auth.set({ ### Hendelser -| Metode | Beskrivelse | Svar | -| ------------------- | ------------------------------ | ------------------------------ | -| `event.subscribe()` | Server-sendte hendelser stream | Server-sendte hendelser stream | +| Metode | Beskrivelse | Svar | +| ------------------- | -------------------------------- | -------------------------------- | +| `event.subscribe()` | Strøm av server-sendte hendelser | Strøm av server-sendte hendelser | --- |