Skip to content
Syndra

Reference

CLI

Manage projects, environments and keys from your terminal.

On this page

Install the CLI globally, or run it on demand with npx syndra.

Terminal
npm install -g syndra

Commands

syndra init

Creates a project and writes syndra.config.ts and .env in the current directory.

Terminal
syndra init [--name <name>] [--region <region>]

syndra dev

Starts a local sync server with an in-memory store ideal for tests and offline development.

Terminal
syndra dev --port 4010
Terminal
  ◆ Syndra dev server v2.4.0

  ➜ Local:     ws://localhost:4010
  ➜ Inspector: http://localhost:4010/_inspect

syndra deploy

Validates and deploys access rules and resolvers.

Terminal
syndra deploy [--env <environment>] [--dry-run]

syndra keys

Terminal
syndra keys list
syndra keys create --env production --type public
syndra keys revoke <key-id>

syndra inspect

Streams operations for a document in real time.

Terminal
syndra inspect lists/groceries --follow

Global flags

Flag Description
--project, -p Override the project from syndra.config.ts.
--json Output machine-readable JSON.
--verbose Print debug logs.
--help, -h Show help for any command.