LOKUST Documentation¶
Technical reference for the LOKUST platform. Written for operators.
Start here¶
- Quick start — install the CLI + daemon, create your first session
- The
.lokfile format — portable session state specification - Vision — what LOKUST is, what it's for
Reference¶
Command-line tools¶
| Tool | Purpose | Docs |
|---|---|---|
lokust |
Session lifecycle CLI | cli/lokust.md |
lokust-shell-snapshot |
Capture a terminal session to a .lok file |
cli/shell-tools.md |
lokust-shell-restore |
Restore a captured shell session | cli/shell-tools.md |
lokust-tmux |
Persistent tmux-backed sessions | cli/shell-tools.md |
Services¶
| Service | Purpose | Docs |
|---|---|---|
lokustd |
Background daemon managing sessions | api/lokustd-http.md |
lokust-stream |
WebRTC streaming server for the iPad portal | api/stream-server.md |
Protocols & formats¶
| Spec | Docs |
|---|---|
.lok file format |
lok-format.md |
| WebRTC signaling protocol | protocol/webrtc-signaling.md |
| Session VM WIT interface | api/session-vm-wit.md |
Infrastructure¶
- Infrastructure README — Terraform + DigitalOcean + Cloudflare setup
- iPad app README — building and running LokustIpad
- Session VM README — streaming server architecture
Versioning¶
All artifacts in this repo use semver starting at 0.x. The .lok file format uses
a monotonic format_version field; the current version is 1.
Conventions¶
- Brand voice: operator-grade, direct, confident. See
design-system/brand/voice-and-tone.md. - Numeric data, timestamps, identifiers: JetBrains Mono.
- Prose: Inter.
- Dark mode is the only product mode.
- Signal color (
#F5A623) is reserved for live in-flight session state.