@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. Your
.npmrc must include the registry configuration and a valid SYNTHETIQ_NPM_KEY environment variable. See getting set up for details.Command reference
| Command | Description |
|---|---|
| Workspace | |
synthetiq init | Initialize the current directory as a workspace |
synthetiq login | Authenticate with Synthetiq |
synthetiq logout | Clear stored credentials |
synthetiq whoami | Display current user and organization |
| Apps | |
synthetiq app list | List apps in workspace |
synthetiq app create | Create a new app |
synthetiq app clone | Clone an existing app |
synthetiq app config | Configure app settings |
synthetiq app package | Build a production package |
synthetiq app push | Publish a new version |
synthetiq app versions | List all versions |
synthetiq app set-active | Set active version |
| Services | |
synthetiq service list | List services in workspace |
synthetiq service create | Create a new service |
synthetiq service config | Configure service credentials |
synthetiq service auth | Authenticate with an OAuth service |
synthetiq service client | Generate a typed client for a service |
synthetiq service push | Publish a new version |
synthetiq service versions | List all versions |
synthetiq service set-active | Set active version |
| 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 install | Install from a store |
synthetiq shared list | List entities shared with you |
synthetiq shared install | Install a shared entity |
| Sharing | |
synthetiq share | Share an app or service |
synthetiq share list | List shares for an entity |
synthetiq share remove | Remove a share |
synthetiq publisher add | Add a publisher |
synthetiq publisher remove | Remove a publisher |
synthetiq publisher list | List publishers |
| Runtime | |
synthetiq run | Start API server and MCP gateway |
synthetiq server | Start the API server |
synthetiq gateway | Start the MCP gateway |
| Agent | |
synthetiq agent | Send a message to the workspace agent |
synthetiq agent chats | List agent conversations |
| Deploy | |
synthetiq deploy | Deploy an app |
synthetiq deploy list | List deployment history |
synthetiq deploy status | Get deployment status |
synthetiq deploy cancel | Cancel an active deployment |
synthetiq deploy delete | Delete a production app |
| Provision | |
synthetiq provision | Provision BYOI infrastructure |
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.