Sync
Build shared terminal applications with a headless TypeScript client.
General-purpose sync for terminals
@cueloop/sync synchronizes application data between terminal and browser clients.
Use it as a standalone library or through cueloop's experimental multiplayer integration.
Your application defines its schema, permissions, interface, and execution adapters.
- Subscribe to typed, live queries.
- Submit durable changes with identities and recoverable receipts.
- Merge shared text and map collaborator selections.
- Keep presence separate from saved history.
- Recover clients, restore authorities, and transfer workspaces.
Install @cueloop/sync
Try the quickstart to merge two edits locally or test live clients against isolated services. Then build an application and use the CLI.
npm install @cueloop/sync@alpha
What runs where
Terminal or browser client
-> Zero cache
-> authenticated application handlers
-> PostgreSQL
The cache replicates authorized query results to clients. Application handlers validate requests and commit changes with their receipts. SQLite can retain a terminal client's replica and drafts on disk. PostgreSQL remains the server's authoritative database. Local hosting uses the same services as remote hosting.
Use sync in cueloop
Open Settings > Experimental > Multiplayer sync, or set:
[experimental]
sync = true
The flag enables cueloop sync and the shared text editor.
Configure an application authority before connecting clients.
Import a local Thread explicitly when it should use that authority.
Existing local Threads keep their local storage and ownership.
See application setup for the owner commands.