Docs

Reference material for the smugglr sync engine. The sidebar groups pages by how you use them: getting going, understanding the machine.

Start

• Get Started. Five minutes to your first push.
• CLI Reference. Every command, every flag, every exit code.
• Configuration. The complete config file.

Internals

• How It Works. Content hashing, the sync algorithm, plugins, the relay, LAN broadcast.
• Usage Patterns. Cookbook scenarios with full config and CLI examples.
• Plugin Guide. The http-sql plugin, shipped profiles, adding a custom target.
• Concepts. Content is truth. Encryption as membership. Agent-first design.

Browser

• Browser Client. The npm package: init, push/pull/sync/diff, the table-changed event, autoSync, OPFS/wa-sqlite, and the zustand/nanostores bridges.