CLI overview

The Synthetiq CLI (@synthetiq/cli) provides commands for the full development lifecycle — scaffolding workspaces, creating apps and services, running local development servers, packaging for production, and deploying to cloud infrastructure.

Installation

The CLI is published to the Synthetiq private npm registry, so a plain npm install -g @synthetiq/cli won’t resolve it — npm needs the registry and an auth token for the @synthetiq scope. Install it in one command, passing the registry and token as flags:

npm install -g @synthetiq/cli \
  --@synthetiq:registry=https://api.synthetiq.com/api/npm/ \
  --//api.synthetiq.com/api/npm/:_authToken=<YOUR_NPM_KEY>

Or configure ~/.npmrc once so global installs pick it up:

@synthetiq:registry=https://api.synthetiq.com/api/npm/
//api.synthetiq.com/api/npm/:_authToken=${SYNTHETIQ_NPM_KEY}

export SYNTHETIQ_NPM_KEY=<your org npm key>
npm install -g @synthetiq/cli

This requires your org’s npm key, found in the Synthetiq Console under Settings → Account.

Command reference

Command	Description
Workspace
`synthetiq login`	Authenticate with Synthetiq
`synthetiq logout`	Clear stored credentials
`synthetiq whoami`	Display current user and organization
`synthetiq org list`	List organizations you belong to
`synthetiq org switch`	Switch the active organization context
Apps (local)
`synthetiq app package`	Build a production package
Entities
`synthetiq entity create`	Create an entity (metadata)
`synthetiq entity get`	Show an entity
`synthetiq entity details`	Show enriched entity details
`synthetiq entity update`	Update entity metadata
`synthetiq entity delete`	Delete an entity
`synthetiq entity set-active`	Set the active version
`synthetiq entity version`	List/download/delete versions
`synthetiq entity share`	Manage user shares
`synthetiq entity publisher`	Manage publishers
Store
`synthetiq store list`	List available stores
`synthetiq store browse`	Browse apps and services in a store
`synthetiq store search`	Search across stores
`synthetiq store publications`	List your org’s store publications
`synthetiq store publish`	Publish an entity to your org store
`synthetiq store unpublish`	Remove an entity from your org store
`synthetiq shared list`	List entities shared with you
`synthetiq shared by-me`	List entities you have shared
Production apps
`synthetiq production-app list`	List production apps
`synthetiq production-app get`	Show a production app
`synthetiq production-app create`	Create a production app
`synthetiq production-app update`	Update a production app
`synthetiq production-app delete`	Delete a production app
`synthetiq production-app oauth-credentials`	Provision OAuth credentials
Deploy
`synthetiq deploy create`	Deploy a version to a production app
`synthetiq deploy list`	List deployment history
`synthetiq deploy get`	Get deployment status
`synthetiq deploy cancel`	Cancel an active deployment
Infrastructure
`synthetiq infra init`	Write the BYOI infrastructure config
`synthetiq infra generate`	Preview infrastructure changes as a reviewable changeset
`synthetiq infra provision`	Apply the reviewed changeset
`synthetiq infra status`	Show the organization’s registered deployment target
`synthetiq infra permissions`	Print the required IAM policy
Organization
`synthetiq member`	Manage organization members
`synthetiq role`	Manage organization roles
`synthetiq scope list`	List permission scopes
`synthetiq storage-config`	Manage external storage
Service accounts
`synthetiq service-account create`	Create a service account
`synthetiq service-account list`	List service accounts
`synthetiq service-account update`	Update a service account
`synthetiq service-account delete`	Delete a service account
`synthetiq trust create`	Trust an OIDC issuer/subject to authenticate as a service account
`synthetiq trust list`	List OIDC trusts
`synthetiq trust update`	Update an OIDC trust
`synthetiq trust delete`	Delete an OIDC trust

Global options

Flag	Description
`--help`, `-h`	Show help for any command
`--version`, `-v`	Print the CLI version

Workspace context

Most commands operate within a Synthetiq workspace — a directory containing _apps/, _mcp/, _service_clients/, and a .synthetiq/ configuration directory. The workspace is tied to the authenticated user and organization, with state stored at ~/.synthetiq/<userId>/<orgId>/. Commands like login, logout, and whoami operate globally and store credentials at ~/.synthetiq/credentials.json.

Platform Docs

Synthetiq Desktop

Synthetiq CLI

App Framework

Services Framework

Workflows Framework

Platform API

Deployments

CLI overview

Installation

Command reference

Global options

Workspace context

​Installation

​Command reference

​Global options

​Workspace context

Installation

Command reference

Global options

Workspace context