CLI command reference
Every public CLI command, argument, and option, grouped by task.
Use synq <command> --help to check the version installed on your machine. <value> is required; [value] is optional. Aliases appear beside the command name.
| Option | Meaning |
|---|
-V, --version | output the version number |
--json | Machine-readable JSON output (stdout data only) |
--native-config <file> | Run SDK commands using an explicitly trusted JavaScript configuration |
-h, --help | display help for command |
Put global options before the command, for example synq --json project list. See native mode before using --native-config.
| Command | Purpose |
|---|
synq login | Authenticate with a Personal Access Token (create one in dashboard Settings) |
synq logout | Remove the stored Synq token |
synq context | Manage connection contexts (list/use/add/rm) |
synq token | Manage personal access tokens |
synq api | Make an authenticated request to any Synq API route (like gh api) |
| Command | Purpose |
|---|
synq init | Link the current directory to an Synq project (.synq/project.json) |
synq config | Author and validate synq.json (declarative deploy config) |
synq deploy | Trigger a deployment for the current project |
synq deployment | Manage deployments (list, inspect, redeploy, rollback, …) |
synq logs | View or stream a deployment's logs |
| Command | Purpose |
|---|
synq project | Manage Synq projects |
synq app | Browse, install, and configure catalog apps |
synq service | Manage the services in a compose stack (a multi-service project) |
synq domain | Manage custom domains, DNS verification, and SSL certificates |
| Command | Purpose |
|---|
synq job | Manage self-hosted jobs, schedules, and run logs |
synq server | Manage self-hosted SSH servers |
synq backup | Manage backups: policies, runs, restores, destinations |
synq edge | Install and manage the OpenResty edge (reverse proxy, TLS, per-route rules) |
synq mail | Self-hosted mail server (iRedMail) setup and admin [self-host] |
synq system | Instance settings, onboarding, migration, and data transfer |
| Command | Purpose |
|---|
synq up | Start Synq as a persistent service (boot + auto-restart); --foreground to run attached |
synq stop | Stop Synq (started by synq up) — it won't restart or return on reboot |
synq status | Show the local Synq service (installed/running, ports) and the active context's API health |
synq doctor | Check database + services health and repair a corrupt local database |
synq open | Open the Synq dashboard in your browser |
synq install | Download and install the Synq desktop app (Mac or Windows) from synquic.tech |
synq update | Update the Synq CLI + bundled server to the latest release |
synq uninstall | Remove Synq from this machine: stop it, delete its data (database, certs, edge config), its images, and ~/.synq. Deployed apps are left running. |
synq reset-admin-password | Reset the local admin login on THIS machine (no sign-in required) |
synq panel-domain | Show the panel's address, or move the panel to https://<host> with a Let's Encrypt certificate (run on the server, as root) |
synq apps-domain | Show or change the domain free app subdomains use on this server (<app>.<apps domain>) |
synq host-network | Show, allow or refuse host networking (network_mode: host) for this server's services (run on the server, as root) |