CLICommand referencesystemmigration

system migration

Commands, arguments, and options for synq system migration.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

synq system migration

Team-mode migration lifecycle

synq system migration [options] [command]
SubcommandPurpose
preflight [options]Read-only readiness check for the own-server migration
start [options]Migrate this instance onto your own server
start-cloud [options]Migrate this instance to Synq Cloud
start-tunnel [options]Expose this instance via an edge tunnel
switch-back [options]Reverse migration back to single-user (teammates lose access)

synq system migration preflight

Read-only readiness check for the own-server migration

synq system migration preflight [options]
OptionMeaning
--server-id <id>Target server id
--hostname <host>Custom domain pointing at the server
--slug <slug>Hosted-cloud free-subdomain slug (not available in Synq; use --hostname)

synq system migration start

Migrate this instance onto your own server

synq system migration start [options]
OptionMeaning
--server-id <id>Target server id
--hostname <host>Custom domain pointing at the server
--slug <slug>Hosted-cloud free-subdomain slug (not available in Synq; use --hostname)

synq system migration start-cloud

Migrate this instance to Synq Cloud

synq system migration start-cloud [options]
OptionMeaning
--allow-non-empty-targetProceed even if the cloud org already has projects

synq system migration start-tunnel

Expose this instance via an edge tunnel

synq system migration start-tunnel [options]
OptionMeaning
--slug <slug>Tunnel slug

synq system migration switch-back

Reverse migration back to single-user (teammates lose access)

synq system migration switch-back [options]
OptionMeaning
--abandon-remoteSkip pulling remote data; keep the local DB as-is
-y, --yesSkip the confirmation prompt

On this page