Operations

Administration and operation of the Sync-in server via NPM and the command-line interface (CLI).

The Sync-in CLI covers common server lifecycle operations, including initialization, starting and stopping services, user management, as well as updates and database migrations.

Command	Description
npx sync-in-server init	Copies the default config file environment.yaml
npx sync-in-server start	Starts the server in attached mode
npx sync-in-server start -d	Starts the server in detached mode (daemon)
npx sync-in-server stop	Stops the server
npx sync-in-server status	Shows the server status (daemon mode only)
npx sync-in-server version	Displays the installed version
npx sync-in-server migrate-db	Runs database migrations
npx sync-in-server update	Updates the server to the latest available version
npx sync-in-server create-user	Create a user or administrator in the database
npx sync-in-server help	Displays help and the list of available commands

info

The --prefix option can be added to any command if you're running npx sync-in-server from a directory other than where it was installed.

tip

npx sync-in-server update also runs database migrations automatically.