Serveur

La commande opencode serve excute un serveur HTTP sans tte qui expose un point de terminaison OpenAPI qu’un client opencode peut utiliser.

---

Utilisation

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

Options

Flag	Description	Default
--port	Port d’coute	4096
--hostname	Nom d’hte d’coute	127.0.0.1
--mdns	Activer la dcouverte mDNS	false
--cors	Origines de navigateur supplmentaires autoriser	[]

--cors peut tre pass plusieurs fois :

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

---

Fonctionnement

Lorsque vous excutez opencode, il dmarre un TUI et un serveur. Le TUI est le client qui communique avec le serveur. Le serveur expose un point de terminaison de spcification OpenAPI 3.1. Ce point de terminaison est galement utilis pour gnrer un SDK.

Astuce

Utilisez le serveur opencode pour interagir avec opencode par programmation.

Cette architecture permet opencode de prendre en charge plusieurs clients et vous permet d’interagir avec opencode par programmation.

Vous pouvez excuter opencode serve pour dmarrer un serveur autonome. Si le TUI opencode est en cours d’excution, opencode serve dmarrera un nouveau serveur.

---

Se connecter un serveur existant

Lorsque vous dmarrez le TUI, il assigne alatoirement un port et un nom d’hte. Vous pouvez la place passer le --hostname et le --port indicateurs. Ensuite, utilisez-le pour vous connecter son serveur.

Le point de terminaison /tui peut tre utilis pour piloter le TUI via le serveur. Par exemple, vous pouvez prremplir ou excuter un prompt. Cette configuration est utilise par les plugins IDE d’OpenCode.

---

Spcification

Le serveur publie une spcification OpenAPI 3.1 qui peut tre consulte :

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

Par exemple, http://localhost:4096/doc. Utilisez la spcification pour gnrer des clients ou inspecter les types de requte et de rponse. Ou consultez-la dans un explorateur Swagger.

---

API

Le serveur opencode expose les API suivantes.

---

Global

Method	Path	Description	Response
GET	/global/health	Obtenir la sant du serveur et la version	{ healthy: true, version: string }
GET	/global/event	Obtenir les vnements globaux (flux SSE)	Flux d’vnements

---

Project

Method	Path	Description	Response
GET	/project	Lister tous les projets	Project[]
GET	/project/current	Obtenir le projet actuel	Project

---

Path & VCS

Method	Path	Description	Response
GET	/path	Obtenir le chemin actuel	Path
GET	/vcs	Obtenir les infos VCS pour le projet actuel	VcsInfo

---

Instance

Method	Path	Description	Response
POST	/instance/dispose	Supprimer l’instance actuelle	boolean

---

Config

Method	Path	Description	Response
GET	/config	Obtenir les infos de configuration	Config
PATCH	/config	Mettre jour la configuration	Config
GET	/config/providers	Lister les fournisseurs et les modles par dfaut	{ providers: Provider[], default: { [key: string]: string } }

---

Provider

Method	Path	Description	Response
GET	/provider	Lister tous les fournisseurs	{ all: Provider[], default: {...}, connected: string[] }
GET	/provider/auth	Obtenir les mthodes d’authentification du fournisseur	{ [providerID: string]: ProviderAuthMethod[] }
POST	/provider/{id}/oauth/authorize	Autoriser un fournisseur en utilisant OAuth	ProviderAuthAuthorization
POST	/provider/{id}/oauth/callback	Grer le rappel OAuth pour un fournisseur	boolean

---

Sessions

Method	Path	Description	Notes
GET	/session	Lister toutes les sessions	Retourne Session[]
POST	/session	Crer une nouvelle session	body : { parentID?, title? }, retourne Session
GET	/session/status	Obtenir le statut de session pour toutes les sessions	Retourne { [sessionID: string]: SessionStatus }
GET	/session/:id	Obtenir les dtails de la session	Retourne Session
DELETE	/session/:id	Supprimer une session et toutes ses donnes	Retourne boolean
PATCH	/session/:id	Mettre jour les proprits de la session	body : { title? }, retourne Session
GET	/session/:id/children	Obtenir les sessions enfants d’une session	Retourne Session[]
GET	/session/:id/todo	Obtenir la liste de tches pour une session	Retourne Todo[]
POST	/session/:id/init	Analyser l’application et crer AGENTS.md	body : { messageID, providerID, modelID }, retourne boolean
POST	/session/:id/fork	Forker une session existante un message	body : { messageID? }, retourne Session
POST	/session/:id/abort	Avorter une session en cours	Retourne boolean
POST	/session/:id/share	Partager une session	Retourne Session
DELETE	/session/:id/share	Annuler le partage d’une session	Retourne Session
GET	/session/:id/diff	Obtenir la diff pour cette session	query : messageID?, retourne FileDiff[]
POST	/session/:id/summarize	Rsumer la session	body : { providerID, modelID }, retourne boolean
POST	/session/:id/revert	Rtablir un message	body : { messageID, partID? }, retourne boolean
POST	/session/:id/unrevert	Restaurer tous les messages rtablis	Retourne boolean
POST	/session/:id/permissions/:permissionID	Rpondre une demande d’autorisation	body : { response, remember? }, retourne boolean

---

Messages

Method	Path	Description	Notes
GET	/session/:id/message	Lister les messages dans une session	query : limit?, retourne { info: Message, parts: Part[]}[]
POST	/session/:id/message	Envoyer un message et attendre la rponse	body : { messageID?, model?, agent?, noReply?, system?, tools?, parts }, retourne { info: Message, parts: Part[]}
GET	/session/:id/message/:messageID	Obtenir les dtails du message	Retourne { info: Message, parts: Part[]}
POST	/session/:id/prompt_async	Envoyer un message de manire asynchrone (sans attente)	body : mme que /session/:id/message, retourne 204 No Content
POST	/session/:id/command	Excuter une commande slash	body : { messageID?, agent?, model?, command, arguments }, retourne { info: Message, parts: Part[]}
POST	/session/:id/shell	Excuter une commande shell	body : { agent, model?, command }, retourne { info: Message, parts: Part[]}

---

Commands

Method	Path	Description	Response
GET	/command	Lister toutes les commandes	Command[]

---

Files

Method	Path	Description	Response
GET	/find?pattern=<pat>	Rechercher du texte dans les fichiers	Tableau d’objets de correspondance avec path, lines, line_number, absolute_offset, submatches
GET	/find/file?query=<q>	Trouver des fichiers et rpertoires par nom	string[] (chemins)
GET	/find/symbol?query=<q>	Trouver les symboles de l’espace de travail	Symbol[]
GET	/file?path=<path>	Lister les fichiers et rpertoires	FileNode[]
GET	/file/content?path=<p>	Lire un fichier	FileContent
GET	/file/status	Obtenir le statut des fichiers suivis	File[]

Paramtres de requte /find/file

• query (requis) - chane de recherche (correspondance floue)
• type (facultatif) - limiter les rsultats "file" ou "directory"
• directory (facultatif) - remplacer la racine du projet pour la recherche
• limit (facultatif) - rsultats max (1-200)
• dirs (facultatif) - indicateur obsolte ("false" retourne uniquement les fichiers)

---

Tools (Experimental)

Method	Path	Description	Response
GET	/experimental/tool/ids	Lister tous les ID d’outils	ToolIDs
GET	/experimental/tool?provider=<p>&model=<m>	Lister les outils avec des schmas JSON pour un modle	ToolList

---

LSP, Formatters & MCP

Method	Path	Description	Response
GET	/lsp	Obtenir le statut du serveur LSP	LSPStatus[]
GET	/formatter	Obtenir le statut du formateur	FormatterStatus[]
GET	/mcp	Obtenir le statut du serveur MCP	{ [name: string]: MCPStatus }
POST	/mcp	Ajouter un serveur MCP dynamiquement	body : { name, config }, retourne l’objet de statut MCP

---

Agents

Method	Path	Description	Response
GET	/agent	Lister tous les agents disponibles	Agent[]

---

Logging

Method	Path	Description	Response
POST	/log	crire une entre de journal. Body : { service, level, message, extra? }	boolean

---

TUI

Method	Path	Description	Response
POST	/tui/append-prompt	Ajouter du texte au prompt	boolean
POST	/tui/open-help	Ouvrir la bote de dialogue d’aide	boolean
POST	/tui/open-sessions	Ouvrir le slecteur de session	boolean
POST	/tui/open-themes	Ouvrir le slecteur de thme	boolean
POST	/tui/open-models	Ouvrir le slecteur de modle	boolean
POST	/tui/submit-prompt	Soumettre le prompt actuel	boolean
POST	/tui/clear-prompt	Effacer le prompt	boolean
POST	/tui/execute-command	Excuter une commande ({ command })	boolean
POST	/tui/show-toast	Afficher un toast ({ title?, message, variant })	boolean
GET	/tui/control/next	Attendre la prochaine demande de contrle	Objet de demande de contrle
POST	/tui/control/response	Rpondre une demande de contrle ({ body })	boolean

---

Auth

Method	Path	Description	Response
PUT	/auth/:id	Dfinir les informations d’authentification. Le corps doit correspondre au schma du fournisseur	boolean

---

Events

Method	Path	Description	Response
GET	/event	Flux d’vnements envoys par le serveur. Le premier vnement est server.connected, puis les vnements du bus	Flux d’vnements envoys par le serveur

---

Docs

Method	Path	Description	Response
GET	/doc	Spcification OpenAPI 3.1	Page HTML avec spcification OpenAPI