Tjener
Kommandoen opencode serve kjører en hodeløs HTTP-server som eksponerer et OpenAPI-endepunkt som en OpenCode-klient kan bruke.
opencode serve [--port <number>] [--hostname <string>] [--cors <origin>]Alternativer
| Flagg | Beskrivelse | Standard |
|---|---|---|
--port | Port å lytte på | 4096 |
--hostname | Vertsnavn å lytte på | 127.0.0.1 |
--mdns | Aktiver mDNS-oppdagelse | false |
--mdns-domain | Egendefinert domenenavn for mDNS-tjeneste | opencode.local |
--cors | Ytterligere nettleseropprinnelse som tillates | [] |
--cors kan angis flere ganger:
opencode serve --cors http://localhost:5173 --cors https://app.example.comSett OPENCODE_SERVER_PASSWORD for å beskytte serveren med HTTP grunnleggende autentisering. Brukernavnet er satt til opencode som standard, eller sett OPENCODE_SERVER_USERNAME for å overstyre det. Dette gjelder både opencode serve og opencode web.
OPENCODE_SERVER_PASSWORD=your-password opencode serveNår du kjører opencode starter den en TUI og en server. Der TUI er
klient som snakker med serveren. Serveren viser en OpenAPI 3.1-spesifikasjon
endepunkt. Dette endepunktet brukes også til å generere en SDK.
Denne arkitekturen lar OpenCode støtte flere klienter og lar deg samhandle med OpenCode programmatisk.
Du kan kjøre opencode serve for å starte en frittstående server. Hvis du har
OpenCode TUI kjører, vil opencode serve starte en ny server.
Koble til en eksisterende server
Når du starter TUI, tildeler den tilfeldig en port og vertsnavn. Du kan i stedet sende inn --hostname og --port flagg. Bruk deretter denne til å koble til serveren.
/tui endepunktet kan brukes til å kjøre TUI gjennom serveren. Du kan for eksempel forhåndsutfylle eller kjøre en forespørsel. Dette oppsettet brukes av OpenCode IDE plugins.
Serveren publiserer en OpenAPI 3.1-spesifikasjon som kan vises på:
http://<hostname>:<port>/docFor eksempel http://localhost:4096/doc. Bruk spesifikasjonen til å generere klienter eller inspisere forespørsels- og svartyper. Eller se den i en Swagger-utforsker.
opencode-serveren viser følgende APIer.
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /global/health | Få serverhelse og versjon | { healthy: true, version: string } |
GET | /global/event | Få globale hendelser (SSE strøm) | Eventstrøm |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /project | List alle prosjekter | Project[] |
GET | /project/current | Hent gjeldende prosjekt | Project |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /path | Hent gjeldende bane | Path |
GET | /vcs | Hent VCS-info for gjeldende prosjekt | VcsInfo |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
POST | /instance/dispose | Avslutt gjeldende forekomst | boolean |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /config | Hent konfigurasjonsinformasjon | Config |
PATCH | /config | Oppdater konfigurasjon | Config |
GET | /config/providers | List leverandører og standardmodeller | { providers: Provider[], default: { [key: string]: string } } |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /provider | List alle leverandører | { all: Provider[], default: {...}, connected: string[] } |
GET | /provider/auth | Hent autentiseringsmetoder for leverandør | { [providerID: string]: ProviderAuthMethod[] } |
POST | /provider/{id}/oauth/authorize | Autoriser en leverandør ved å bruke OAuth | ProviderAuthAuthorization |
POST | /provider/{id}/oauth/callback | Håndter OAuth-tilbakeringing for en leverandør | boolean |
| Metode | Sti | Beskrivelse | Merknader |
|---|---|---|---|
GET | /session | List alle økter | Returnerer Session[] |
POST | /session | Opprett en ny økt | body: { parentID?, title? }, returnerer Session |
GET | /session/status | Hent øktstatus for alle økter | Returnerer { [sessionID: string]: SessionStatus } |
GET | /session/:id | Hent øktdetaljer | Returnerer Session |
DELETE | /session/:id | Slett en økt og alle dens data | Returnerer boolean |
PATCH | /session/:id | Oppdater øktegenskaper | body: { title? }, returnerer Session |
GET | /session/:id/children | Hent en økts barneøkter | Returnerer Session[] |
POST | /session/:id/init | Analyser appen og lag AGENTS.md | body: { messageID, providerID, modelID }, returnerer boolean |
POST | /session/:id/fork | Fork en eksisterende økt ved en melding | body: { messageID? }, returnerer Session |
POST | /session/:id/abort | Avbryt en kjørende økt | Returnerer boolean |
GET | /session/:id/diff | Hent diff for denne økten | spørring: messageID?, returnerer FileDiff[] |
POST | /session/:id/summarize | Oppsummer økten | body: { providerID, modelID }, returnerer boolean |
POST | /session/:id/revert | Tilbakestill en melding | body: { messageID, partID? }, returnerer boolean |
POST | /session/:id/unrevert | Gjenopprett alle tilbakestilte meldinger | Returnerer boolean |
POST | /session/:id/permissions/:permissionID | Svar på en tillatelsesforespørsel | body: { response, remember? }, returnerer boolean |
| Metode | Sti | Beskrivelse | Merknader |
|---|---|---|---|
GET | /session/:id/message | List meldinger i en økt | spørring: limit?, returnerer { info: Message, parts: Part[]}[] |
POST | /session/:id/message | Send en melding og vent på svar | body: { messageID?, model?, agent?, noReply?, system?, tools?, parts }, returnerer { info: Message, parts: Part[]} |
GET | /session/:id/message/:messageID | Hent meldingsdetaljer | Returnerer { info: Message, parts: Part[]} |
POST | /session/:id/prompt_async | Send en melding asynkront (ingen vent) | body: samme som /session/:id/message, returnerer 204 No Content |
POST | /session/:id/command | Utfør en slash-kommando | body: { messageID?, agent?, model?, command, arguments }, returnerer { info: Message, parts: Part[]} |
POST | /session/:id/shell | Kjør en shell-kommando | body: { agent, model?, command }, returnerer { info: Message, parts: Part[]} |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /command | List alle kommandoer | Command[] |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /find?pattern=<pat> | Søk etter tekst i filer | En rekke matchobjekter med path, lines, line_number, absolute_offset, submatches |
GET | /find/file?query=<q> | Finn filer og kataloger etter navn | string[] (baner) |
GET | /find/symbol?query=<q> | Finn symboler i arbeidsområdet | Symbol[] |
GET | /file?path=<path> | List filer og kataloger | FileNode[] |
GET | /file/content?path=<p> | Les en fil | FileContent |
GET | /file/status | Hent status for sporede filer | File[] |
/find/file spørringsparametere
query(obligatorisk) - søkestreng (uklar samsvar)type(valgfritt) - begrense resultatene til"file"eller"directory"directory(valgfritt) — overstyr prosjektroten for søketlimit(valgfritt) - maks. resultater (1–200)dirs(valgfritt) - eldre flagg ("false"returnerer kun filer)
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /experimental/tool/ids | Vis alle verktøy-ID-er | ToolIDs |
GET | /experimental/tool?provider=<p>&model=<m> | List verktøy med JSON-skjemaer for en modell | ToolList |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /lsp | Hent LSP-serverstatus | LSPStatus[] |
GET | /formatter | Hent formateringsstatus | FormatterStatus[] |
GET | /mcp | Hent MCP-serverstatus | { [name: string]: MCPStatus } |
POST | /mcp | Legg til MCP-server dynamisk | body: { name, config }, returnerer MCP statusobjekt |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /agent | List alle tilgjengelige agenter | Agent[] |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
POST | /log | Skriv loggoppføring. Body: { service, level, message, extra? } | boolean |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
POST | /tui/append-prompt | Legg til tekst i prompten | boolean |
POST | /tui/open-help | Åpne hjelpedialogen | boolean |
POST | /tui/open-sessions | Åpne øktvelgeren | boolean |
POST | /tui/open-themes | Åpne temavelgeren | boolean |
POST | /tui/open-models | Åpne modellvelgeren | boolean |
POST | /tui/submit-prompt | Send inn gjeldende prompt | boolean |
POST | /tui/clear-prompt | Tøm prompten | boolean |
POST | /tui/execute-command | Utfør en kommando ({ command }) | boolean |
POST | /tui/show-toast | Vis toast ({ title?, message, variant }) | boolean |
GET | /tui/control/next | Vent på neste kontrollforespørsel | Kontrollforespørselsobjekt |
POST | /tui/control/response | Svar på en kontrollforespørsel ({ body }) | boolean |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
PUT | /auth/:id | Angi autentiseringsinformasjon. Body må samsvare med leverandørskjema | boolean |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /event | Strøm av server-sendte hendelser. Første hendelse er server.connected, deretter busshendelser | Strøm av server-sendte hendelser |
| Metode | Sti | Beskrivelse | Svar |
|---|---|---|---|
GET | /doc | OpenAPI 3.1-spesifikasjon | HTML side med OpenAPI-spesifikasjon |