Interface: Sidecar

Defined in: packages/aiui-claude-channel/src/sidecar.ts:63

A mountable session sidecar (see the module doc).

Properties

name

readonly name: string

Defined in: packages/aiui-claude-channel/src/sidecar.ts:65

Stable identifier for logging and CLI selection (e.g. "pencil").

Methods

mount()

mount(app, ctx): MountedSidecar | Promise<MountedSidecar>

Defined in: packages/aiui-claude-channel/src/sidecar.ts:71

Mount the sidecar's routes on the channel's Express app (once, at startup) and return its live handle. May be async — a sidecar that stands up a Vite server or spawns a process does that work here.

Parameters

app

Express

ctx

SidecarContext

Returns

MountedSidecar | Promise<MountedSidecar>