Getting Started
xSwarm is pre-beta. Join the waitlist and we will email you when your invite is ready.
xSwarm is pre-beta. The CLI is not published to npm yet and there is no public install — join the waitlist and we’ll email you when it’s your turn.
What happens when your invite arrives
Your invite email includes the install command and a pairing code. Setup is two steps:
- Connect the machine. The CLI prints a short code and a URL. Open the URL in a
browser where you’re already signed in and approve it — that’s the whole
authentication step, no separate account creation and no password. A credential is
saved to
~/.xswarm/config.json(readable only by you) so you don’t need to do this again on this machine. - Register a project. From inside a project’s directory, the CLI reads its name,
package.json, git remote, and tech stack, and registers it under your account. You can also register every git repository under a folder at once.
Both steps can be undone: unregister a project, or log the machine out entirely. Logging out revokes the machine’s credential on the server, not just locally.
What’s next
A registered project is visible to your account, but nothing runs on it automatically yet. The on-machine daemon does the actual work — see Core Concepts for what it does once it’s running.
Requirements
- Node.js 22+
- A GitHub account, for the browser approval step