CLI

Deploy and manage releases

Deploy a linked project or local folder, follow logs, and control releases.

First connect to an installation or configure native mode.

Deploy a Git project

From your repository, link an existing Synq project whose source is configured:

synq init --project proj_123
synq deploy --watch

Use --project to select a project without changing the local link. Select a branch, commit, variable set, or registered server when needed:

synq deploy --project proj_123 --branch main --env production --watch
synq deploy --project proj_123 --server srv_123 --watch

For a preview, first create or select a non-production project environment in the dashboard, then deploy its project ID. That row owns its own routes, runtime and active release:

synq deploy --project proj_preview --env preview --watch

--env selects stored variables within that project. It does not create a preview runtime or switch project IDs. Preview variables are refused on a production target before deployment starts. Omitting --env uses the project's default production variable set, including the values edited in the dashboard of a preview project.

Deploy a folder

Upload the current directory explicitly, including from a Git checkout:

synq deploy --folder --name my-site --watch

The CLI stages the directory through the shared SDK source workflow. Outside Git, --name also opts into a folder upload for existing scripts. A project ID alone never opts into uploading the current directory. Use --project <id> to redeploy from outside the checkout; the stored branch is used unless --branch is supplied.

--branch, --commit, --smart-route, and --refresh select the Git path and cannot be combined with --folder. --service-ids works for both paths. Archive staging must remain outside the source tree: the system temporary directory and its ancestors are refused. Select your project directory, or set TMPDIR outside the source tree.

Native directory deployment requires the directory to be inside policy.sourceRoots. See folder deployment for packaging behavior.

Select what changes

OptionBehavior
--force-allRebuild all enabled services.
--service-ids svc_a,svc_bSelect services to deploy.
--smart-routeUse source changes to select affected services.
--refreshReapply environment configuration without pulling source or rebuilding.

See the deploy reference for every option.

Inspect progress

synq deployment list --project proj_123
synq deployment get dep_123
synq logs dep_123 --follow

Without --watch, deployment submission returns an ID that you can inspect later. A submitted build is not yet a successful release. Follow the final status and any requested decisions.

Control a release

synq deployment cancel dep_123
synq deployment redeploy dep_123 --use-existing-commit
synq deployment rollback dep_previous

Rollback availability depends on retained artifacts or rebuild support. pin retains a deployment's rollback artifacts; keep and reject settle releases waiting for a decision.

Use the deployment command reference for controls and rollback guide for recovery behavior.

On this page