Server Mode

Name: OpenCode
Author: OpenCode

Tương tác với OpenCode server qua HTTP.

Tổng quan

Lệnh opencode serve chạy headless HTTP server với OpenAPI endpoint. Architecture: TUI là client nói chuyện với server qua HTTP.

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

OPENCODE_SERVER_PASSWORD=your-password opencode serve

Username mặc định: opencode. Override với OPENCODE_SERVER_USERNAME.

Server publish OpenAPI 3.1 spec tại:

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

Ví dụ: http://localhost:4096/doc. Dùng để generate clients hoặc inspect types.

Method	Path	Mô tả
`GET`	`/global/health`	Server health + version
`GET`	`/global/event`	SSE event stream

Method	Path	Mô tả
`GET`	`/session/:id/message`	List messages
`POST`	`/session/:id/message`	Send message + wait for response
`POST`	`/session/:id/prompt_async`	Send message (no wait)
`POST`	`/session/:id/command`	Execute slash command
`POST`	`/session/:id/shell`	Run shell command

Method	Path	Mô tả
`PUT`	`/auth/:id`	Set credentials

Method	Path	Mô tả
`GET`	`/event`	SSE event stream

Khi TUI đang chạy, bạn có thể kết nối tới server của nó:

# Start TUI với port cố định
opencode --port 4096

# Trong terminal khác, dùng SDK để kết nối

import { createOpencodeClient } from "@opencode-ai/sdk"
const client = createOpencodeClient({
  baseUrl: "http://localhost:4096",
})