CLICommand referencedeployment deployment
Commands, arguments, and options for synq deployment.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
Manage deployments (list, inspect, redeploy, rollback, …)
synq deployment|deployments [options] [command]
Cancel an in-progress deployment
synq deployment cancel [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Show a single deployment
synq deployment get [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Show container info for a deployment
synq deployment info [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Keep a finished deployment awaiting a keep/reject decision
synq deployment keep [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
List deployments (org-wide, or scoped to a project)
synq deployment list [options]
| Option | Meaning |
|---|
--project <id> | Scope to a project (defaults to the linked project) |
--env <environment> | Filter by environment: production | preview |
--limit <n> | Max rows to fetch (default: "50") |
Show a deployment's current prompt and pending decisions
synq deployment pending [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Pin (or unpin) a deployment's rollback artifact
synq deployment pin [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--off | Unpin instead of pin |
Redeploy from an existing deployment
synq deployment redeploy [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--use-existing-commit | Rebuild the same commit instead of the latest on the branch |
Reject a finished deployment awaiting a keep/reject decision
synq deployment reject [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Answer a pending deployment prompt
synq deployment respond [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--action <action> | An action ID offered by the pending prompt |
Restart a deployment's container
synq deployment restart [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Delete a deployment
synq deployment rm [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
-y, --yes | Skip the confirmation prompt |
Roll back to a previous deployment
synq deployment rollback [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID to roll back to |
SSL certificate operations
synq deployment ssl [options] [command]
Renew (issue) an SSL certificate for a domain
synq deployment ssl renew [options] <domain>
| Argument | Meaning |
|---|
domain | Domain to renew |
| Option | Meaning |
|---|
--www | Also renew the www subdomain (separately — its own certificate) |
Check SSL certificate status for a domain
synq deployment ssl status [options] <domain>
| Argument | Meaning |
|---|
domain | Domain to probe |
Show container resource usage for a deployment
synq deployment usage [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |