> ## 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.

# Deploy commands

> Trigger and inspect deployments

The `deploy` commands mirror the platform's deploys API — they trigger and
inspect deployments. Managing the deploy target itself (the production app)
lives under [production-app commands](/docs/platform-docs/cli/production-app).

## create

Deploy a version to a production app:

```bash theme={null}
synthetiq deploy create <production-app-id> [--version <version-id>] [--json]
```

| Flag                     | Description                                                 |
| ------------------------ | ----------------------------------------------------------- |
| `--version <version-id>` | Version ID to deploy (default: the entity's active version) |

```
Deployment started: 3c1f8a44-9b2d-4e07-8f1a-6d5c2e9b7a01
Track it with: synthetiq deploy get 3c1f8a44-9b2d-4e07-8f1a-6d5c2e9b7a01
```

Fails with a conflict if a deployment for the production app is already in progress.

## list

```bash theme={null}
synthetiq deploy list [production-app-id] [--status <status>] [--limit <n>] [--page <n>] [--json]
```

```
ID              APP       VERSION          STATUS       DATE
3c1f8a44-…      my-app    0b54f3a8-…       completed    Jun 10, 2026
9b2d4e07-…      my-app    4c81d2e7-…       failed       Jun 5, 2026
```

| Flag                | Description                                               |
| ------------------- | --------------------------------------------------------- |
| `--status <status>` | Filter: `in_progress`, `completed`, `failed`, `cancelled` |
| `--limit <n>`       | Number of deployments to show (default: `10`)             |
| `--page <n>`        | Page number                                               |
| `--json`            | Output as JSON                                            |

## get

Get a deployment's status and phase breakdown:

```bash theme={null}
synthetiq deploy get <deployment-id> [--json]
```

```
Deployment:  3c1f8a44-9b2d-4e07-8f1a-6d5c2e9b7a01
App:         my-app
Version:     0b54f3a8-91c2-4d7e-a6b1-8e2f5c9d3a10
Status:      in_progress
Created:     6/10/2026, 3:30:42 PM

Phases:
  orchestrate          completed
  download             completed
  infra                in_progress
  build                pending
  ...
```

## cancel

```bash theme={null}
synthetiq deploy cancel <deployment-id>
```

Only deployments currently in progress can be cancelled.
