Get started
This guide gets the Node runtime and operator Console running on your machine.
Before you start
You need Node.js 22 and pnpm 10.
sh
pnpm install
pnpm build
pnpm doctorStart the runtime and Console
sh
pnpm up
pnpm dev:consoleOr use pnpm dev:all to also start Studio and the docs site.
Sign in to the Console
- Open http://127.0.0.1:5174.
- Enter the admin token from
apps/parties/synkd.json. - The default lab token is
dev-admin.
You should see fleet up, version, uptime, and room list.
Confirm health without the UI
sh
curl -s http://127.0.0.1:8787/healthz
curl -s http://127.0.0.1:8787/metrics | headAdmin control routes need a Bearer token:
sh
curl -s -H "Authorization: Bearer dev-admin" \
http://127.0.0.1:8787/v1/healthLab secrets
| Setting | Default in repo | Audience |
|---|---|---|
auth.token | dev-token | Guests / Studio |
auth.adminToken | dev-admin | Console / /v1 |
Projects created with synkd init use the same defaults. Change them before any shared or public deploy. See Security.
Optional: local Durable Objects
sh
synkd up --durable
# Studio: http://127.0.0.1:5173/?backend=durable
synkd downProduction fleets: Deploy.