project

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

synq project

Manage Synq projects

synq project|projects [options] [command]

Subcommand	Purpose
`list\|ls`	List projects in the active organization
`get <id>`	Show a single project
`rename <id> <name>`	Change a project's display name
`release-image [options] <id>`	Track and deploy a versioned prebuilt container image
`create [options]`	Create a project
`delete\|rm [options] <id>`	Delete a project (tears down all resources)
`env`	Manage project environment variables
`git`	Manage git linkage and auto-deploy
`connect [options] <id> <domain>`	Connect a custom domain to a project
`enable <id>`	Start a stopped project
`disable <id>`	Stop a running project
`sleep-mode <id> <mode>`	Set the project sleep mode
`notes [options] <id>`	Show or replace the project's Markdown notes
`replicas [options] <id> [count]`	Show or set how many containers an app runs (1-20), and its autoscaling
`transfer <id> <direction>`	Promote a project to Synq Cloud, or bring it back (self-hosted only)
`logs [options] <id>`	Show or stream runtime (container) logs
`server-logs [options] <id>`	Show or stream HTTP request logs (edge/OpenResty)

synq project connect

Connect a custom domain to a project

synq project connect [options] <id> <domain>

Argument	Meaning
`id`	Project ID
`domain`	Custom domain hostname

Option	Meaning
`--include-www`	Also connect the www. variant

synq project create

Create a project

synq project create [options]

Option	Meaning
`--name <name>`	Project name
`--slug <slug>`	Project slug, also the free subdomain <slug>.<apps base domain> when one is set
`--git-owner <owner>`	GitHub owner/org
`--git-repo <repo>`	GitHub repository name
`--git-branch <branch>`	Git branch to deploy
`--framework <framework>`	Stack/framework id
`--local-path <path>`	Local source path
`--port <port>`	Container port
`--type <type>`	Project type: app \| docker \| services \| monorepo
`--server <id>`	Registered server ID (see `synq server list`)

synq project delete

Delete a project (tears down all resources)

synq project delete|rm [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--force`	Cancel active work and delete anyway
`--force-orphan`	Orphan resources that won't destroy, then drop the row
`--wipe-volumes`	Also destroy persistent volumes
`-y, --yes`	Skip the confirmation prompt

synq project disable

Stop a running project

synq project disable [options] <id>

Argument	Meaning
`id`	Project ID

synq project enable

Start a stopped project

synq project enable [options] <id>

Argument	Meaning
`id`	Project ID

synq project env

Manage project environment variables

synq project env [options] [command]

Subcommand	Purpose
`get [options] <id>`	List env vars (secret values are masked by the API)
`set [options] <id>`	Merge env vars: upsert KEY=VALUE pairs and/or delete keys

synq project env get

List env vars (secret values are masked by the API)

synq project env get [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--environment <env>`	Filter by environment (production\|preview\|development)

synq project env set

Merge env vars: upsert KEY=VALUE pairs and/or delete keys

synq project env set [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--environment <env>`	Target environment (default: "production")
`--set <pair>`	KEY=VALUE to upsert (repeatable) (default: [])
`--unset <key>`	KEY to delete (repeatable) (default: [])
`--secret`	Mark every --set value as a secret

synq project get

Show a single project

synq project get [options] <id>

Argument	Meaning
`id`	Project ID

synq project list

List projects in the active organization

synq project list|ls [options]

synq project logs

Show or stream runtime (container) logs

synq project logs [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--tail <n>`	Number of recent lines
`-f, --follow`	Stream logs until interrupted

synq project notes

Show or replace the project's Markdown notes

synq project notes [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--set <markdown>`	Replace the notes with this Markdown text
`--file <path>`	Replace the notes with the contents of a file (- reads stdin)
`--clear`	Remove the notes

synq project release-image

Track and deploy a versioned prebuilt container image

synq project release-image [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--image-template <reference>`	Image reference with {tag} or {version}, e.g. ghcr.io/acme/api:{tag}
`--github-repo <owner/repo>`	Resolve versions from GitHub Releases
`--version-url <https-url>`	HTTPS endpoint returning a version or tag
`--pin <version>`	Deploy a fixed version instead of the discovered latest release

synq project rename

Change a project's display name

synq project rename [options] <id> <name>

Argument	Meaning
`id`	Project ID
`name`	New display name

synq project replicas

Show or set how many containers an app runs (1-20), and its autoscaling

synq project replicas [options] <id> [count]

Argument	Meaning
`id`	Project ID
`count`	Replica count to run now (1-20)

Option	Meaning
`--autoscale <on\|off>`	Turn autoscaling on or off
`--min <n>`	Autoscale: fewest replicas
`--max <n>`	Autoscale: most replicas (up to 20)
`--cpu <percent>`	Autoscale: CPU target in % (default 70)
`--memory <percent>`	Autoscale: memory target in %, or 'none'
`--allow-shared-volumes`	Confirm every replica may mount the app's writable volumes
`--no-apply`	Only save; the next deploy applies it

synq project server-logs

Show or stream HTTP request logs (edge/OpenResty)

synq project server-logs [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--limit <n>`	Number of recent entries (max 200)
`--domain <domain>`	Restrict to a specific domain
`-f, --follow`	Stream request logs until interrupted

synq project sleep-mode

Set the project sleep mode

synq project sleep-mode [options] <id> <mode>

Argument	Meaning
`id`	Project ID
`mode`	One of: auto_sleep, always_on

synq project transfer

Promote a project to Synq Cloud, or bring it back (self-hosted only)

synq project transfer [options] <id> <direction>

Argument	Meaning
`id`	Project ID
`direction`	One of: to-cloud, to-self-hosted

On this page