> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paradime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Bolt CLI

<Info>
  **Prerequisites:**

  * This feature is available with the [**Paradime Bolt plan**](https://www.paradime.io/pricing)**.**
  * Your API keys ***must*** have either Bolt Schedules Admin or Bolt Schedules Metadata Viewer capabilities.
</Info>

<Warning>
  **Schedules are identified by slug.** The positional argument on `paradime bolt run`, `paradime bolt schedule retry`, `paradime bolt schedule suspend`, and `paradime bolt schedule unsuspend` is the schedule's **slug** — the identifier returned by `createBoltSchedule` and shown in the Bolt UI.
</Warning>

### Trigger a Bolt Run

Using the Paradime CLI, you can trigger a run for a given Bolt schedule slug.

**CLI command**

```bash theme={"system"}
paradime bolt run "<slug>"
```

**Options**

| Flag          | Type               | Description                                                                                 |
| ------------- | ------------------ | ------------------------------------------------------------------------------------------- |
| `--branch`    | *`Optional, TEXT`* | Git branch name or commit hash to checkout.                                                 |
| `--command`   | *`Optional, TEXT`* | Command(s) to override the default commands.                                                |
| `--pr-number` | *`Optional, INT`*  | Pull request number to associate with the run.                                              |
| `--reason`    | *`Optional, TEXT`* | Freeform reason/label describing why or from where the run was triggered.                   |
| `--wait`      |                    | Wait for the run to finish, **streaming stdout/stderr from each command live** as they run. |
| `--json`      |                    | JSON formatted response (suppresses live log output).                                       |
| `--help`      |                    | Show CLI command options and exit.                                                          |

**Examples**

<Tabs>
  <Tab title="Trigger Bolt schedule run and stream live logs">
    <Info>
      Trigger a Bolt schedule run, then **stream stdout and stderr live** for each command as it runs and exit with the final run status. Useful for CI pipelines or local debugging where you want to see exactly what's happening as it happens.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt run "flowing-pachy-wyy4fs" --wait
    ```

    **Example output**
  </Tab>

  <Tab title="Trigger Bolt schedule run with command override">
    <Info>
      Trigger a Bolt schedule run, and override the schedule commands at runtime.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt run "flowing-pachy-wyy4fs" --command "dbt run -s order_items", "dbt test"  --wait
    ```

    **Example output**
  </Tab>

  <Tab title="Trigger Bolt schedule run with git branch override">
    <Info>
      Trigger a Bolt schedule run, and override the git branch at runtime.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt run "flowing-pachy-wyy4fs" --branch "feature-branch-123" --wait
    ```

    **Example output**
  </Tab>

  <Tab title="Trigger Bolt schedule run with a reason">
    <Info>
      Trigger a Bolt schedule run with a freeform reason describing why or from where it was triggered (e.g. the application that made the call). The reason is stored with the run for context and auditing.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt run "flowing-pachy-wyy4fs" --reason "triggered by data-quality-bot" --wait
    ```

    **Example output**
  </Tab>
</Tabs>

### Retry the latest failed run of a schedule

Using the Paradime CLI, you can retry the **latest failed run** of a Bolt schedule by name, without needing to know the run ID. The retry resumes from the failed command of the most recent run of the schedule. Infrastructure commands (`git clone`, `dbt deps`) are always excluded — they run automatically on every Bolt run.

A new Bolt run is created and its run ID is printed. The original failed run is unchanged.

**CLI command**

```bash theme={"system"}
paradime bolt schedule retry "<slug>"
```

**Options**

| Flag     | Type | Description                                                                                                                         |
| -------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `--wait` |      | Wait for the retry run to finish, **streaming stdout/stderr from each command live**. Exits non-zero if the retry does not succeed. |
| `--json` |      | JSON formatted response.                                                                                                            |
| `--help` |      | Show CLI command options and exit.                                                                                                  |

**Examples**

<Tabs>
  <Tab title="Retry latest failed run and wait for status">
    <Info>
      Retry the latest failed run of a Bolt schedule by name, and block until the new run reaches a terminal state.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt schedule retry "flowing-pachy-wyy4fs" --wait
    ```
  </Tab>

  <Tab title="Retry as JSON (CI-friendly)">
    <Info>
      Retry the latest failed run of a Bolt schedule and return the new run ID as JSON, useful when chaining the CLI in CI pipelines.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt schedule retry "flowing-pachy-wyy4fs" --json
    ```
  </Tab>
</Tabs>

### Retry a Bolt Run

Using the Paradime CLI, you can retry a failed Bolt run by passing its run ID. By default only the failed commands are re-run (using `dbt retry` when supported); pass `--all` to re-run every original command. Infrastructure commands (`git clone`, `dbt deps`) are always excluded — they run automatically on every Bolt run.

A new Bolt run is created and its run ID is printed. The original run is unchanged.

**CLI command**

```bash theme={"system"}
paradime bolt retry <run_id>
```

**Options**

| Flag     | Type | Description                                                                                                                         |
| -------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `--all`  |      | Retry ALL commands from the original run (default: failed commands only).                                                           |
| `--wait` |      | Wait for the retry run to finish, **streaming stdout/stderr from each command live**. Exits non-zero if the retry does not succeed. |
| `--json` |      | JSON formatted response.                                                                                                            |
| `--help` |      | Show CLI command options and exit.                                                                                                  |

**Examples**

<Tabs>
  <Tab title="Retry failed commands and wait for status">
    <Info>
      Retry only the failed commands from a previous Bolt run, and block until the new run reaches a terminal state.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt retry 15509 --wait
    ```
  </Tab>

  <Tab title="Retry all commands">
    <Info>
      Re-run every original command verbatim from a previous Bolt run, regardless of which ones succeeded or failed.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt retry 15509 --all --wait
    ```
  </Tab>

  <Tab title="Retry as JSON (CI-friendly)">
    <Info>
      Retry a Bolt run and return the new run ID as JSON, useful when chaining the CLI in CI pipelines.
    </Info>

    **CLI command**

    ```bash theme={"system"}
    paradime bolt retry 15509 --json
    ```
  </Tab>
</Tabs>

### Download a Bolt Schedule artifacts

Using the Paradime CLI, you can download the latest artifacts of a given Bolt schedule slug.

**CLI command**

```bash theme={"system"}
paradime bolt artifact
```

**Options**

| Flag                              | Type                  | Description                                                                                                             |
| --------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `--slug` *(or `--schedule-name`)* | *`Required, TEXT`*    | The Bolt schedule's slug. `--schedule-name` is accepted as a deprecated alias and behaves identically.                  |
| `--artifact-path`                 | *`Optional, TEXT`*    | The path to the artifact in the Bolt run. \[default: target/manifest.json]                                              |
| `--command-index`                 | *`Optional, INTEGER`* | The index of the command in the schedule. Defaults to searching through all commands from the last command to the first |
| `--output-path`                   | *`Optional, TEXT`*    | The path to save the artifact. Defaults to the current directory.                                                       |
| `--help`                          |                       | Show CLI command options and exit.                                                                                      |

**Examples**

<Tabs>
  <Tab title="Get Bolt schedule manifest.json">
    <Info>
      Get Bolt schedule `manifest.json` from the latest run.
    </Info>

    **CLI command**

    ```
    paradime bolt artifact --slug "flowing-pachy-wyy4fs"
    ```
  </Tab>

  <Tab title="Get Bolt schedule run_results.json">
    <Info>
      Get Bolt schedule `run_results.json` from the latest run.
    </Info>

    **CLI command**

    ```
    paradime bolt artifact --slug "flowing-pachy-wyy4fs" --artifact-path target/run_results.json
    ```

    **Example output**
  </Tab>

  <Tab title="Legacy: --schedule-name still works">
    <Warning>
      The `--schedule-name` flag is kept for backwards compatibility with existing shell scripts and behaves identically to `--slug`. Prefer `--slug` for new scripts.
    </Warning>

    **CLI command**

    ```
    paradime bolt artifact --schedule-name "dailxy-run"
    ```
  </Tab>
</Tabs>

### Bolt Schedules Suspend

<Danger>
  YAML schedules **cannot** be "suspended" via the CLI.
</Danger>

Using the Paradime CLI, you can programmatically suspend a Bolt Schedule. This will be marked as "Paused". Schedules in "Paused" state will not run.

**CLI Command**

```bash theme={"system"}
paradime bolt schedule suspend "<slug>"
```

**Examples**

<Tabs>
  <Tab title="Suspend a Bolt Schedule">
    **CLI Command**

    ```bash theme={"system"}
    paradime bolt schedule suspend "flowing-pachy-wyy4fs"
    ```
  </Tab>
</Tabs>

### Bolt Schedules Unsuspend

<Danger>
  YAML schedules **cannot** be "unsuspend" via the CLI.
</Danger>

Using the Paradime CLI, you can programmatically unsuspand a Bolt Schedule when in a "Paused" state. This is normally used in combination with the Bolt Schedules Suspend CLI command.

When a Bolt schedule is "Unsuspended", runs will resume.

**CLI Command**

```bash theme={"system"}
paradime bolt schedule unsuspend "<slug>"
```

**Examples**

<Tabs>
  <Tab title="Unsuspend a Bolt Schedule">
    **CLI Command**

    ```bash theme={"system"}
    paradime bolt schedule unsuspend "flowing-pachy-wyy4fs"
    ```
  </Tab>
</Tabs>

**CLI Command**

```bash theme={"system"}
paradime bolt schedule unsuspend "<slug>"
```

### Verify paradime\_schedule.yml configuration file

Using the Paradime CLI, you can verify that your paradime\_schedules.yml configuration file containting the YAML configured Bolt schedules is correct and free of errors.

**CLI Command**

```bash theme={"system"}
<strong>paradime bolt verify
</strong>
```

**Options**

| Flag   | Type               | Description                                                               |
| ------ | ------------------ | ------------------------------------------------------------------------- |
| --path | *`Optional, TEXT`* | Path to paradime\_schedules.yml file. \[default: paradime\_schedules.yml] |
| --help |                    | Show CLI command options and exit.                                        |

**Examples**

<Tabs>
  <Tab title="Verify paradime_schedules.yml file">
    <Info>
      Verify the paradime\_schedules.yml file with the Bolt schedules configurations does not contain errors.
    </Info>

    **CLI Command**

    ```bash theme={"system"}
    paradime bolt verify --path /workspace/repository/dbt/paradime_schedules.yml
    ```
  </Tab>
</Tabs>


## Related topics

- [Paradime CLI](/developers/paradime-cli/index.md)
- [Getting Started](/developers/paradime-cli/getting-started.md)
- [Fivetran CLI](/developers/paradime-cli/fivetran-cli.md)
- [Airbyte CLI](/developers/paradime-cli/airbyte-cli.md)
- [Tableau CLI](/developers/paradime-cli/tableau-cli.md)