Q
Q-OSprotocol
For BusinessesFor EngineersRegistryPricing
Read the Docs ↗Start Building
Q
Q-OS
Docsv0.1.0
Search docs...⌘K
IntroductionQuick StartInstallationYour First Module
›System OverviewEdge Node (Rust Daemon)Sled State StoreWebSocket TelemetryCRDT Sync Protocol
Overviewqos_abi::read_inputqos_abi::write_outputqos_abi::state_getqos_abi::state_setError Handling
OverviewGuest Check-In ModuleMenu & OrderingVIP ValidationInventory SyncCustom Broadcast Logic
⬡ GitHub ↗▶ API Reference
Docs›Architecture
Architecture

System Overview

Q-OS is a layered, local-first compute platform. Every component is designed to operate independently of the internet. The four core layers below interact over in-process function calls and LAN sockets — never cloud APIs.

01

Edge Node (Rust Daemon)

qos-api

The heart of Q-OS. A single Actix-Web binary that owns the local Sled database, executes WASM modules in a sandboxed Wasmtime runtime, and streams telemetry over WebSocket.

→
02

Sled State Store

K/V · Local-First

An embedded, ACID-compliant key-value store. All state is written to disk atomically. No external database, no SQLite — Sled lives inside the daemon process itself.

→
03

WebSocket Telemetry Stream

/api/v1/stream

A persistent WebSocket endpoint that broadcasts every STATE_MUTATION, EXECUTION_RECEIPT, and SYSTEM_BROADCAST event as NDJSON in real time.

→
04

CRDT Sync Protocol

mDNS · Mesh

When multiple edge nodes are on the same LAN, they discover each other via mDNS and synchronize state using a conflict-free replicated data type (CRDT) merge strategy.

→

Want to dive straight into code?

Read the Quick Start →

On this page

OverviewPrerequisitesStep 1 — InstallStep 2 — Write ModuleStep 3 — Build & DeployStep 4 — VerifyNext Steps
Q-OSv0.1.0-alpha

© 2026 Q-OS Protocol. Built on Rust. Open Source.

FeaturesDevelopersPricingGitHub