Server

Der Befehl opencode serve fhrt einen kopflosen HTTP-Server aus, der einen OpenAPI-Endpunkt bereitstellt, den ein opencode-Client verwenden kann.

---

Verwendung

opencode serve [--port <number>] [--hostname <string>] [--cors <origin>]

Optionen

Flag	Description	Default
--port	Port fr den Listen	4096
--hostname	Hostname fr den Listen	127.0.0.1
--mdns	mDNS-Entdeckung aktivieren	false
--cors	Zustzliche Browser-Originale zulassen	[]

--cors kann mehrfach bergeben werden:

opencode serve --cors http://localhost:5173 --cors https://app.example.com

---

Funktionsweise

Wenn Sie opencode ausfhren, wird ein TUI und ein Server gestartet. Das TUI ist der Client, der mit dem Server kommuniziert. Der Server stellt einen OpenAPI 3.1-Spezifikations-Endpunkt bereit. Dieser Endpunkt wird auch verwendet, um ein SDK zu generieren.

Tipp

Verwenden Sie den opencode-Server, um programmgesteuert mit opencode zu interagieren.

Diese Architektur ermglicht es opencode, mehrere Clients zu untersttzen und es Ihnen zu ermglichen, programmgesteuert mit opencode zu interagieren.

Sie knnen opencode serve ausfhren, um einen eigenstndigen Server zu starten. Wenn der opencode-TUI luft, wird opencode serve einen neuen Server starten.

---

Mit einem vorhandenen Server verbinden

Wenn Sie das TUI starten, wird zufllig ein Port und ein Hostname zugewiesen. Sie knnen stattdessen die --hostname und --port Flags bergeben. Verwenden Sie diese dann, um eine Verbindung mit seinem Server herzustellen.

Der /tui-Endpunkt kann verwendet werden, um das TUI ber den Server zu steuern. Sie knnen beispielsweise einen Prompt vorab ausfllen oder ausfhren. Dieses Setup wird von den OpenCode-IDE-Plugins verwendet.

---

Spezifikation

Der Server verffentlicht eine OpenAPI 3.1-Spezifikation, die unter folgender Adresse angezeigt werden kann:

http://<hostname>:<port>/doc

Zum Beispiel http://localhost:4096/doc. Verwenden Sie die Spezifikation, um Clients zu generieren oder Anforderungs- und Antworttypen zu berprfen. Oder anzeigen Sie sie in einem Swagger-Explorer.

---

APIs

Der opencode-Server stellt die folgenden APIs bereit.

---

Global

Method	Path	Description	Response
GET	/global/health	Server-Status und Version abrufen	{ healthy: true, version: string }
GET	/global/event	Globale Events abrufen (SSE-Stream)	Event-Stream

---

Project

Method	Path	Description	Response
GET	/project	Alle Projekte auflisten	Project[]
GET	/project/current	Aktuelles Projekt abrufen	Project

---

Path & VCS

Method	Path	Description	Response
GET	/path	Aktuellen Pfad abrufen	Path
GET	/vcs	VCS-Informationen fr das aktuelle Projekt abrufen	VcsInfo

---

Instance

Method	Path	Description	Response
POST	/instance/dispose	Aktuelle Instanz entsorgen	boolean

---

Config

Method	Path	Description	Response
GET	/config	Konfigurations-Informationen abrufen	Config
PATCH	/config	Konfiguration aktualisieren	Config
GET	/config/providers	Anbieter und Standardmodelle auflisten	{ providers: Provider[], default: { [key: string]: string } }

---

Provider

Method	Path	Description	Response
GET	/provider	Alle Anbieter auflisten	{ all: Provider[], default: {...}, connected: string[] }
GET	/provider/auth	Anbieter-Authentifizierungsmethoden abrufen	{ [providerID: string]: ProviderAuthMethod[] }
POST	/provider/{id}/oauth/authorize	Anbieter mit OAuth autorisieren	ProviderAuthAuthorization
POST	/provider/{id}/oauth/callback	OAuth-Callback fr einen Anbieter verarbeiten	boolean

---

Sessions

Method	Path	Description	Notes
GET	/session	Alle Sitzungen auflisten	Gibt Session[] zurck
POST	/session	Neue Sitzung erstellen	body: { parentID?, title? }, gibt Session zurck
GET	/session/status	Sitzungsstatus fr alle Sitzungen abrufen	Gibt { [sessionID: string]: SessionStatus } zurck
GET	/session/:id	Sitzungsdetails abrufen	Gibt Session zurck
DELETE	/session/:id	Sitzung und alle ihre Daten lschen	Gibt boolean zurck
PATCH	/session/:id	Sitzungseigenschaften aktualisieren	body: { title? }, gibt Session zurck
GET	/session/:id/children	Kindersitzungen einer Sitzung abrufen	Gibt Session[] zurck
GET	/session/:id/todo	Todo-Liste fr eine Sitzung abrufen	Gibt Todo[] zurck
POST	/session/:id/init	App analysieren und AGENTS.md erstellen	body: { messageID, providerID, modelID }, gibt boolean zurck
POST	/session/:id/fork	Vorhandene Sitzung bei einer Nachricht forken	body: { messageID? }, gibt Session zurck
POST	/session/:id/abort	Laufende Sitzung abbrechen	Gibt boolean zurck
POST	/session/:id/share	Sitzung teilen	Gibt Session zurck
DELETE	/session/:id/share	Freigabe der Sitzung aufheben	Gibt Session zurck
GET	/session/:id/diff	Diff fr diese Sitzung abrufen	query: messageID?, gibt FileDiff[] zurck
POST	/session/:id/summarize	Sitzung zusammenfassen	body: { providerID, modelID }, gibt boolean zurck
POST	/session/:id/revert	Nachricht zurcknehmen	body: { messageID, partID? }, gibt boolean zurck
POST	/session/:id/unrevert	Alle zurckgenommenen Nachrichten wiederherstellen	Gibt boolean zurck
POST	/session/:id/permissions/:permissionID	Auf eine Berechtigungsanfrage antworten	body: { response, remember? }, gibt boolean zurck

---

Messages

Method	Path	Description	Notes
GET	/session/:id/message	Nachrichten in einer Sitzung auflisten	query: limit?, gibt { info: Message, parts: Part[]}[] zurck
POST	/session/:id/message	Nachricht senden und auf Antwort warten	body: { messageID?, model?, agent?, noReply?, system?, tools?, parts }, gibt { info: Message, parts: Part[]} zurck
GET	/session/:id/message/:messageID	Nachrichtendetails abrufen	Gibt { info: Message, parts: Part[]} zurck
POST	/session/:id/prompt_async	Nachricht asynchron senden (kein Warten)	body: gleich wie /session/:id/message, gibt 204 No Content zurck
POST	/session/:id/command	Slash-Befehl ausfhren	body: { messageID?, agent?, model?, command, arguments }, gibt { info: Message, parts: Part[]} zurck
POST	/session/:id/shell	Shell-Befehl ausfhren	body: { agent, model?, command }, gibt { info: Message, parts: Part[]} zurck

---

Commands

Method	Path	Description	Response
GET	/command	Alle Befehle auflisten	Command[]

---

Files

Method	Path	Description	Response
GET	/find?pattern=<pat>	Text in Dateien suchen	Array von bereinstimmungsobjekten mit path, lines, line_number, absolute_offset, submatches
GET	/find/file?query=<q>	Dateien und Verzeichnisse nach Name finden	string[] (Pfade)
GET	/find/symbol?query=<q>	Arbeitsbereich-Symbole finden	Symbol[]
GET	/file?path=<path>	Dateien und Verzeichnisse auflisten	FileNode[]
GET	/file/content?path=<p>	Eine Datei lesen	FileContent
GET	/file/status	Status fr verfolgte Dateien abrufen	File[]

/find/file Abfrageparameter

• query (erforderlich) - Suchzeichenkette (Fuzzy-Match)
• type (optional) - Ergebnisse auf "file" oder "directory" beschrnken
• directory (optional) - Stammverzeichnis fr die Suche berschreiben
• limit (optional) - Max Ergebnisse (1-200)
• dirs (optional) - veraltetes Flag ("false" gibt nur Dateien zurck)

---

Tools (Experimental)

Method	Path	Description	Response
GET	/experimental/tool/ids	Alle Tool-IDs auflisten	ToolIDs
GET	/experimental/tool?provider=<p>&model=<m>	Tools mit JSON-Schemas fr ein Modell auflisten	ToolList

---

LSP, Formatters & MCP

Method	Path	Description	Response
GET	/lsp	LSP-Server-Status abrufen	LSPStatus[]
GET	/formatter	Formatter-Status abrufen	FormatterStatus[]
GET	/mcp	MCP-Server-Status abrufen	{ [name: string]: MCPStatus }
POST	/mcp	MCP-Server dynamisch hinzufgen	body: { name, config }, gibt MCP-Status-Objekt zurck

---

Agents

Method	Path	Description	Response
GET	/agent	Alle verfgbaren Agents auflisten	Agent[]

---

Logging

Method	Path	Description	Response
POST	/log	Log-Eintrag schreiben. Body: { service, level, message, extra? }	boolean

---

TUI

Method	Path	Description	Response
POST	/tui/append-prompt	Text an Prompt anhngen	boolean
POST	/tui/open-help	Hilfe-Dialog ffnen	boolean
POST	/tui/open-sessions	Sitzungs-Auswahl ffnen	boolean
POST	/tui/open-themes	Themen-Auswahl ffnen	boolean
POST	/tui/open-models	Modellauswahl ffnen	boolean
POST	/tui/submit-prompt	Aktuellen Prompt absenden	boolean
POST	/tui/clear-prompt	Prompt lschen	boolean
POST	/tui/execute-command	Befehl ausfhren ({ command })	boolean
POST	/tui/show-toast	Toast anzeigen ({ title?, message, variant })	boolean
GET	/tui/control/next	Auf nchste Steueranfrage warten	Steueranfrage-Objekt
POST	/tui/control/response	Auf Steueranfrage antworten ({ body })	boolean

---

Auth

Method	Path	Description	Response
PUT	/auth/:id	Authentifizierungs-Anmeldedaten festlegen. Body muss zum Anbieter-Schema passen	boolean

---

Events

Method	Path	Description	Response
GET	/event	Server-Sent-Events-Stream. Erstes Event ist server.connected, dann Bus-Events	Server-Sent-Events-Stream

---

Docs

Method	Path	Description	Response
GET	/doc	OpenAPI 3.1 Spezifikation	HTML-Seite mit OpenAPI-Spezifikation