Synq CLI
Deploy applications and manage Synq from your terminal.
Use the CLI to deploy code, inspect releases, manage services, and operate a self-hosted installation.
Install
The CLI comes with your server: the installer (see Install on a new server)
puts synq in /usr/local/bin, at the same version as the panel, and every upgrade updates it. Synq runs as root,
so run it with sudo on the server:
sudo synq status
sudo synq --helpIt isn't published to npm or offered as a separate download. The reference follows the current release; use
--help to check the version on your server.
Connect and deploy
Manage the installation on this machine, or connect to an existing one:
synq login \
--api-url https://app.example.com \
--dashboard-url https://app.example.com \
--context production
synq project list
synq init --project proj_123
synq deploy --watchlogin opens the token settings page and asks for a personal access token. init links the current
directory to a project. deploy --watch submits a deployment and follows its progress.
Choose a workflow
Use synq job (alias jobs) to manage scheduled jobs, manual runs, and logs.
Connect and authenticate
Manage contexts, tokens, and direct HTTP requests.
Deploy and inspect releases
Deploy folders or Git projects, read logs, and roll back.
Manage applications
Work with projects, services, domains, and catalog apps.
Operate infrastructure
Manage servers, backups, mail, and installation settings.
Use native SDK mode
Run supported commands against an explicitly configured native installation.
Complete command reference
Every command, subcommand, argument, and option, grouped by task.
Scripts and application code
Use synq --json project list for machine-readable command output. See automation
for CI setup and exit handling. To call the same operations directly from JavaScript or TypeScript,
use the Node.js SDK.