> ## Documentation Index
> Fetch the complete documentation index at: https://ravion-b90c0359-devin-1788408180-cross-module-output-refs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ravion deploy

> Trigger, list, inspect, promote, and roll back Ravion module deployments from the command line using the `ravion deploy` command group.

## `ravion deploy`

Manage deployments

**Aliases:** `deploys`, `deployment`, `deployments`

### `ravion deploy cancel`

Cancel a deployment

```bash theme={null}
ravion deploy cancel <id> [flags]
```

**Flags:**

| Flag     | Required | Description           |
| -------- | -------- | --------------------- |
| `--json` |          | emit response as JSON |

### `ravion deploy continue`

Continue a paused deployment

```bash theme={null}
ravion deploy continue <id> [flags]
```

**Flags:**

| Flag                 | Required | Description                                                                                                                                                                                                                                          |
| -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--hook-id <string>` |          | Pause-hook id to resolve. Optional — when omitted the deploy workflow targets the hook it is currently paused on (the common case; linear/canary deploys pause once per traffic-shift step, each with a fresh hook id surfaced on the PAUSED event). |
| `--json`             |          | emit response as JSON                                                                                                                                                                                                                                |

### `ravion deploy create`

Create a deployment for a module

```bash theme={null}
ravion deploy create [flags]
```

**Flags:**

| Flag                            | Required | Description                                                             |
| ------------------------------- | -------- | ----------------------------------------------------------------------- |
| `--description <string>`        | yes      | User-provided description shown in dashboards and audit logs. Required. |
| `--module-instance-id <string>` | yes      | Module instance ID                                                      |
| `--inputs <string>`             |          | Deploy-time input values                                                |
| `--json`                        |          | emit response as JSON                                                   |

### `ravion deploy definition`

Get what a deployment applied

```bash theme={null}
ravion deploy definition <id> [flags]
```

**Flags:**

| Flag     | Required | Description           |
| -------- | -------- | --------------------- |
| `--json` |          | emit response as JSON |

### `ravion deploy get`

Get Deployment by id

```bash theme={null}
ravion deploy get <id> [flags]
```

**Flags:**

| Flag     | Required | Description           |
| -------- | -------- | --------------------- |
| `--json` |          | emit response as JSON |

### `ravion deploy list`

List Deployments

```bash theme={null}
ravion deploy list [flags]
```

**Flags:**

| Flag                                              | Required | Description                                                                                         |
| ------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
| `--cursor <string>`                               |          | cursor                                                                                              |
| `--environment-id <string>`                       |          | environmentId                                                                                       |
| `--id <strings>`                                  |          | id                                                                                                  |
| `--json`                                          |          | emit response as JSON                                                                               |
| `--limit <int>`                                   |          | limit                                                                                               |
| `--limit-per-module-instance <moduleInstanceIds>` |          | When set together with moduleInstanceIds, return only the newest N deployments per module instance. |
| `--module-instance-id <string>`                   |          | moduleInstanceId                                                                                    |
| `--module-instance-ids <limit>`                   |          | Return deployments belonging to any of these module instances, newest first, bounded by limit.      |
| `--pipeline-run-id <string>`                      |          | pipelineRunId                                                                                       |
| `--status <strings>`                              |          | Filter to deployments in any of these statuses.                                                     |
| `-v, --verbose`                                   |          | show full output                                                                                    |

### `ravion deploy redeploy`

Redeploy a deployment

```bash theme={null}
ravion deploy redeploy <id> [flags]
```

**Flags:**

| Flag     | Required | Description           |
| -------- | -------- | --------------------- |
| `--json` |          | emit response as JSON |

### `ravion deploy resource`

Manage deployment resources

**Aliases:** `resources`

#### `ravion deploy resource get`

Get DeploymentResource by id

```bash theme={null}
ravion deploy resource get <id> [flags]
```

**Flags:**

| Flag     | Required | Description           |
| -------- | -------- | --------------------- |
| `--json` |          | emit response as JSON |

#### `ravion deploy resource list`

List DeploymentResources

```bash theme={null}
ravion deploy resource list [flags]
```

**Flags:**

| Flag                            | Required | Description           |
| ------------------------------- | -------- | --------------------- |
| `--cursor <string>`             |          | cursor                |
| `--deployment-id <string>`      |          | deploymentId          |
| `--json`                        |          | emit response as JSON |
| `--lifecycle-type <string>`     |          | lifecycleType         |
| `--limit <int>`                 |          | limit                 |
| `--module-instance-id <string>` |          | moduleInstanceId      |
| `--type <string>`               |          | type                  |
| `-v, --verbose`                 |          | show full output      |

#### `ravion deploy resource restart`

Restart an EKS workload

```bash theme={null}
ravion deploy resource restart <id> [flags]
```

**Flags:**

| Flag                   | Required | Description                                                                                                                                                                                                                                                                                  |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--json`               |          | emit response as JSON                                                                                                                                                                                                                                                                        |
| `--wait-seconds <int>` |          | How long, in seconds, the agent watches for the replacement pods to become ready before answering. Omitted takes the agent's default; a negative value asks it not to wait at all. Clamped by both the control plane and the agent, so a caller can only ever ask for less than the ceiling. |

#### `ravion deploy resource rollback`

Roll an EKS workload's Helm release back

```bash theme={null}
ravion deploy resource rollback <id> [flags]
```

**Flags:**

| Flag                         | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--revision <helm rollback>` | yes      | Helm's own revision number, from the release's history — not a Ravion identifier. Required and must be positive: helm rollback with no revision means "the previous one", and after a failed upgrade the previous revision and the last revision known to have WORKED are not the same one, so the caller has to say which it means.  It is validated against the revisions Ravion RECORDED for this module instance's prior successful deploys, and then again by the agent against Helm's actual in-cluster history. Both checks are needed and neither subsumes the other: the control plane cannot read a private cluster's release Secrets, and Helm prunes its history to `--max-history`, so a revision Ravion recorded may no longer be there to reinstate. |
| `--json`                     |          | emit response as JSON                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `--timeout-seconds <int>`    |          | Seconds bounding the whole rollback, Helm's own wait included. Omitted takes the agent's default. Clamped on both ends.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

### `ravion deploy rollback`

Start a rollback deployment

```bash theme={null}
ravion deploy rollback <id> [flags]
```

**Flags:**

| Flag     | Required | Description           |
| -------- | -------- | --------------------- |
| `--json` |          | emit response as JSON |

### `ravion deploy rollback-candidates`

List rollback candidates

```bash theme={null}
ravion deploy rollback-candidates <id> [flags]
```

**Flags:**

| Flag            | Required | Description           |
| --------------- | -------- | --------------------- |
| `--json`        |          | emit response as JSON |
| `-v, --verbose` |          | show full output      |

### `ravion deploy wait`

Wait for a deployment to finish, or to reach the status given by --until.

Use this instead of polling `ravion deploy get` in a loop. With --watch the command prints
status changes as they happen, then exits when the deployment is done. The command exits
non-zero when the deployment fails, is cancelled, or is rolled back.

```bash theme={null}
ravion deploy wait <id> [flags]
```

**Examples:**

```bash theme={null}
ravion deploy wait dep_123 --watch
ravion deploy wait dep_123 --watch --timeout 30m
ravion deploy wait dep_123 --until IN_PROGRESS --watch
```

**Flags:**

| Flag                   | Required | Description                                                  |
| ---------------------- | -------- | ------------------------------------------------------------ |
| `--json`               |          | emit response as JSON                                        |
| `--timeout <duration>` |          | maximum time to wait; zero waits indefinitely                |
| `--until <string>`     |          | return when this status is reached, for example IN\_PROGRESS |
| `--watch`              |          | print deployment status changes while waiting                |
