> ## Documentation Index > Fetch the complete documentation index at: https://synthetiq.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # CLI overview > Install and use the Synthetiq CLI to manage workspaces, apps, services, and deployments 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: ```bash theme={null} npm install -g @synthetiq/cli \ --@synthetiq:registry=https://api.synthetiq.com/api/npm/ \ --//api.synthetiq.com/api/npm/:_authToken= ``` Or configure `~/.npmrc` once so global installs pick it up: ```ini theme={null} @synthetiq:registry=https://api.synthetiq.com/api/npm/ //api.synthetiq.com/api/npm/:_authToken=${SYNTHETIQ_NPM_KEY} ``` ```bash theme={null} export SYNTHETIQ_NPM_KEY= npm install -g @synthetiq/cli ``` This requires your org's npm key, found in the [Synthetiq Console](https://console.synthetiq.com) under **Settings → Account**. ## Command reference | Command | Description | | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | **Workspace** | | | [`synthetiq login`](/docs/platform-docs/cli/workspace#login) | Authenticate with Synthetiq | | [`synthetiq logout`](/docs/platform-docs/cli/workspace#logout) | Clear stored credentials | | [`synthetiq whoami`](/docs/platform-docs/cli/workspace#whoami) | Display current user and organization | | [`synthetiq org list`](/docs/platform-docs/cli/workspace#org-list) | List organizations you belong to | | [`synthetiq org switch`](/docs/platform-docs/cli/workspace#org-switch) | Switch the active organization context | | **Apps (local)** | | | [`synthetiq app package`](/docs/platform-docs/cli/apps#package) | Build a production package | | **Entities** | | | [`synthetiq entity create`](/docs/platform-docs/cli/entity#create) | Create an entity (metadata) | | [`synthetiq entity get`](/docs/platform-docs/cli/entity#get) | Show an entity | | [`synthetiq entity details`](/docs/platform-docs/cli/entity#details) | Show enriched entity details | | [`synthetiq entity update`](/docs/platform-docs/cli/entity#update) | Update entity metadata | | [`synthetiq entity delete`](/docs/platform-docs/cli/entity#delete) | Delete an entity | | [`synthetiq entity set-active`](/docs/platform-docs/cli/entity#set-active) | Set the active version | | [`synthetiq entity version`](/docs/platform-docs/cli/entity#version) | List/download/delete versions | | [`synthetiq entity share`](/docs/platform-docs/cli/entity#share) | Manage user shares | | [`synthetiq entity publisher`](/docs/platform-docs/cli/entity#publisher) | Manage publishers | | **Store** | | | [`synthetiq store list`](/docs/platform-docs/cli/store#list) | List available stores | | [`synthetiq store browse`](/docs/platform-docs/cli/store#browse) | Browse apps and services in a store | | [`synthetiq store search`](/docs/platform-docs/cli/store#search) | Search across stores | | [`synthetiq store publications`](/docs/platform-docs/cli/store#publications) | List your org's store publications | | [`synthetiq store publish`](/docs/platform-docs/cli/store#publish) | Publish an entity to your org store | | [`synthetiq store unpublish`](/docs/platform-docs/cli/store#unpublish) | Remove an entity from your org store | | [`synthetiq shared list`](/docs/platform-docs/cli/store#shared-list) | List entities shared with you | | [`synthetiq shared by-me`](/docs/platform-docs/cli/store#shared-by-me) | List entities you have shared | | **Production apps** | | | [`synthetiq production-app list`](/docs/platform-docs/cli/production-app#list) | List production apps | | [`synthetiq production-app get`](/docs/platform-docs/cli/production-app#get) | Show a production app | | [`synthetiq production-app create`](/docs/platform-docs/cli/production-app#create) | Create a production app | | [`synthetiq production-app update`](/docs/platform-docs/cli/production-app#update) | Update a production app | | [`synthetiq production-app delete`](/docs/platform-docs/cli/production-app#delete) | Delete a production app | | [`synthetiq production-app oauth-credentials`](/docs/platform-docs/cli/production-app#oauth-credentials) | Provision OAuth credentials | | **Deploy** | | | [`synthetiq deploy create`](/docs/platform-docs/cli/deploy#create) | Deploy a version to a production app | | [`synthetiq deploy list`](/docs/platform-docs/cli/deploy#list) | List deployment history | | [`synthetiq deploy get`](/docs/platform-docs/cli/deploy#get) | Get deployment status | | [`synthetiq deploy cancel`](/docs/platform-docs/cli/deploy#cancel) | Cancel an active deployment | | **Infrastructure** | | | [`synthetiq infra init`](/docs/platform-docs/cli/infra#init) | Write the BYOI infrastructure config | | [`synthetiq infra generate`](/docs/platform-docs/cli/infra#generate) | Preview infrastructure changes as a reviewable changeset | | [`synthetiq infra provision`](/docs/platform-docs/cli/infra#provision) | Apply the reviewed changeset | | [`synthetiq infra status`](/docs/platform-docs/cli/infra#status) | Show the organization's registered deployment target | | [`synthetiq infra permissions`](/docs/platform-docs/cli/infra#permissions) | Print the required IAM policy | | **Organization** | | | [`synthetiq member`](/docs/platform-docs/cli/organization#member) | Manage organization members | | [`synthetiq role`](/docs/platform-docs/cli/organization#role) | Manage organization roles | | [`synthetiq scope list`](/docs/platform-docs/cli/organization#scope) | List permission scopes | | [`synthetiq storage-config`](/docs/platform-docs/cli/organization#storage-config) | Manage external storage | | **Service accounts** | | | [`synthetiq service-account create`](/docs/platform-docs/cli/service-account#create) | Create a service account | | [`synthetiq service-account list`](/docs/platform-docs/cli/service-account#list) | List service accounts | | [`synthetiq service-account update`](/docs/platform-docs/cli/service-account#update) | Update a service account | | [`synthetiq service-account delete`](/docs/platform-docs/cli/service-account#delete) | Delete a service account | | [`synthetiq trust create`](/docs/platform-docs/cli/trust#create) | Trust an OIDC issuer/subject to authenticate as a service account | | [`synthetiq trust list`](/docs/platform-docs/cli/trust#list) | List OIDC trusts | | [`synthetiq trust update`](/docs/platform-docs/cli/trust#update) | Update an OIDC trust | | [`synthetiq trust delete`](/docs/platform-docs/cli/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///`. Commands like `login`, `logout`, and `whoami` operate globally and store credentials at `~/.synthetiq/credentials.json`.