page

Docs

Curated entry points into the uterm architecture, control-channel protocol, and per-package documentation.

The public site keeps docs short and curated. The full reference lives in the main repository.

Start here

Key repo docs

docs/ARCHITECTURE.md — the canonical architecture report. This site is built from it.
packages/provide-uterm — core library: control channel, ANSI engine, DeckMux.
packages/provide-uterm-server — TermHub reference implementation.
packages/provide-uterm-cloudflare — edge backend on Durable Objects.
packages/provide-uterm-client — Python SDK and MCP server.
packages/provide-uterm-frontend — xterm.js + DeckMux UI.

Concept model

uterm is organized around five concepts:

Session — a single PTY-backed conversation, owned by exactly one worker.
Hub — the multiplexer that owns the control channel for a session.
Worker — the process that exposes a PTY; can be local or remote.
Participant — a viewer, operator, or admin attached to a session.
Tunnel — a binary channel multiplexed alongside the terminal stream (TCP forward, HTTP inspect).

Every protocol decision falls out of those five concepts.

When to use this page

Use the site pages to orient yourself. Jump into the repository when you need exact module entry points, configuration keys, or the source behind a feature.