SSyncropel Docs

Get Started

The installation-to-live-workspace journey for Syncropel. Install the CLI, initialize your identity, start your workspace, and pair devices.

This section takes you from "I just heard about Syncropel" to "I have a secure workspace 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

#PageWhat it covers
0PricingLocal is free. One hosted workspace is free per person, with no card; more are $25 per month each with a 30-day free trial.
1Hosted workspace signupSkip install: sign up at syncropel.com and get a fully-portable workspace ready in about two minutes.
2InstallDownload and install spl on Linux, Windows, or macOS. Pin versions. Verify.
3First runspl init, your identity, the ~/.syncro/ tree, and config.toml.
4Your first hourThe first question your workspace asks, the register, and your assistant answering.
5The assistantThe chief of staff: your default assistant, and what you can read, change, and replace.
6Pairing a browser or phoneQR pairing, manual pairing, revocation.
7TroubleshootingDiagnostic tree for the failure modes real users have hit.
8Reset and uninstallClean reset, full uninstall per platform, what survives.

Suggested reading order

First time, want a hosted workspace. Read Hosted workspace signup: the syncropel.com flow gets you to a working workspace without installing anything. Then spl token save <bearer> to get the CLI talking to your hosted workspace, 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 workspace.

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 workspace is doing real work
  • spl doctor: one-command diagnostic when a workspace is misbehaving

On this page