Overview
System Bridge runs on your desktop and exposes your system over a local API and WebSocket. Use these guides to get set up and start integrating.
Getting Started
Section titled “Getting Started”InstallDownload and install System Bridge on Windows or Linux.
RunningStart System Bridge and keep it running.
DevelopingBuild, run, and test System Bridge from source.
DesktopUse the system tray and desktop app launcher.
CLIControl System Bridge from the command line.
TUIControl System Bridge from an interactive terminal interface.
Web ClientMonitor and control System Bridge from the browser.
Home AssistantMonitor and control your machine from Home Assistant.
OverviewBase URL, authentication and the three protocols.
HTTPSimple request/response reads over the HTTP API.
Status & HealthCheck whether the backend is running.
DataRequest system data over the HTTP API.
Media File DataAccess media file information.
MCP ServerConnect agents over the Model Context Protocol.
WebSocket
Section titled “WebSocket”OverviewConnection URL, message envelopes and errors.
DataRequest, subscribe to and receive system data.
InputSend keyboard keypresses and text.
ControlMedia, notifications, opening files/URLs and power.
SystemFiles, settings, commands and exiting the app.
LLMsFeed the documentation to an agent using llms.txt.