Get Started
The installation-to-live-instance journey for Syncropel. Install the CLI, initialize your identity, start your instance, and pair devices.
This section takes you from "I just heard about Syncropel" to "I have a secure instance running with a browser paired to it." It is intentionally more detailed than the Quickstart — read Quickstart if you want the 10-minute happy path; read this section if something went wrong on your first try, or if you're setting up a machine that will do real work.
Map
| # | Page | What it covers |
|---|---|---|
| 0 | Pricing | Trial + paid tier limits at a glance. |
| 1 | Hosted instance signup | Skip install — sign up at syncropel.com and get a fully-portable instance running in under a minute. |
| 2 | Install | Download and install spl on Linux, Windows, or macOS. Pin versions. Verify. |
| 3 | First run | spl init, your identity, the ~/.syncro/ tree, and config.toml. |
| 4 | Pairing a browser or phone | QR pairing, manual pairing, revocation. |
| 5 | Troubleshooting | Diagnostic tree for the failure modes real users have hit. |
| 6 | Reset and uninstall | Clean reset, full uninstall per platform, what survives. |
Suggested reading order
First time, want a hosted instance. Read Hosted instance signup — the syncropel.com flow gets you to a working instance without installing anything. Then spl token save <bearer> to get the CLI talking to your hosted instance, then jump to Pairing for additional devices.
First time installing locally. Start at Install, proceed through First run, then Pairing once you want a browser or second device on the same instance.
Pairing a second device. Jump to Pairing.
Something is broken right now. Troubleshooting first, then Reset and uninstall if you need to start over.
What "Syncropel" means on your machine
spl is a single binary. Once installed, it is both the CLI (spl task list, spl intend …) and the server (spl serve). They communicate over a local Unix socket on Linux and macOS, and over TCP on Windows. The server persists everything it knows to ~/.syncro/hub.db, a SQLite file.
That's the whole system. No Docker required, no separate language runtime, no external database. The pages in this section are about getting that one binary installed correctly and pointing it at a well-formed ~/.syncro/ directory.
See also
- Quickstart — the 10-minute walkthrough
- Operator Runbook — day-2 operations once your instance is doing real work
spl doctor— one-command diagnostic when an instance is misbehaving