CLI

Projects, services, and domains

Manage application configuration and related resources from the CLI.

Resource commands use the active connection context or your selected native configuration.

Projects

synq project list
synq project create --name my-app --git-owner my-team --git-repo my-app
synq project get proj_123
synq project rename proj_123 "My application"
synq init --project proj_123

project rename updates the display name through the same operation as the dashboard. The project ID, slug, volumes, and live routes keep their existing identities. Manage hostnames with the domain commands below.

init writes a project link in .synq/project.json. This is different from synq.json, which declares deployment configuration:

synq config init
synq config validate

See project commands, link options, and configuration commands.

Environment and source settings

synq project env get proj_123
synq project git branch proj_123 main
synq project sleep-mode proj_123 always_on
synq project notes proj_123 --file RUNBOOK.md

Run several copies of an app on its server, or let Synq scale it with the load:

synq project replicas proj_123 3
synq project replicas proj_123 --autoscale on --min 2 --max 6 --cpu 70

Replicas and autoscaling explains the balancing, the health checks and the rules. Use the project reference for environment writes, auto-deploy, release images, logs, and project teardown. Environment variables explains secret handling and when changes reach a running application.

Services

synq service list --project proj_123
synq service get svc_123 --project proj_123
synq service logs svc_123 --project proj_123 --follow

Services belong to a project. Supply --project or use a linked directory. The service reference covers creation, Compose synchronization, drift decisions, environment variables, runtime controls, and execution.

Domains

synq domain add app.example.com --project proj_123
synq domain records dom_123
synq domain verify dom_123
synq domain verify-ssl dom_123

Follow the returned DNS instructions before verification. See domain options and the custom-domain guide for DNS providers, TLS, and primary domains.

Catalog apps

synq app list
synq app get postgres
synq app host-fit postgres --server srv_123

app install creates an installation draft. Deploy the returned project ID with synq deploy. Custom app definitions, curated settings, and connection details are covered in the app reference.

On this page