> For the complete documentation index, see [llms.txt](https://docs.paradime.io/app-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.paradime.io/app-help/developers-old/paradime-cli/bolt-cli.md).

# Bolt CLI

{% hint style="info" %}

* 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](/app-help/developers/generate-api-keys.md) capabilities.
  {% endhint %}

## Trigger a Bolt Run

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

### CLI command

```bash
paradime bolt run "<schedule_name>"
```

### 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. |
| `--wait`      |                    | Wait for the run to finish                     |
| `--json`      |                    | JSON formatted response                        |
| `--help`      |                    | Show CLI command options and exit.             |

### Examples

{% tabs %}
{% tab title="Trigger Bolt schedule run and wait for status" %}
{% hint style="info" %}
Trigger a Bolt schedule run, and return the status until is completed.
{% endhint %}

**CLI command**

```bash
paradime bolt run "daily run" --wait
```

**Example output**

<figure><img src="/files/FSdbxUB0oeAHEgMtkM2Y" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Trigger Bolt schedule run with command override" %}
{% hint style="info" %}
Trigger a Bolt schedule run, and override the schedule commands at runtime.
{% endhint %}

**CLI command**

```bash
paradime bolt run "daily run" --command "dbt run -s order_items", "dbt test"  --wait
```

**Example output**

<figure><img src="/files/rHhrbSLvlzuUaCVc2Aki" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Trigger Bolt schedule run with git branch override" %}
{% hint style="info" %}
Trigger a Bolt schedule run, and override the git branch at runtime.
{% endhint %}

**CLI command**

```bash
paradime bolt run "daily run" --branch "feature-branch-123" --wait
```

**Example output**

<figure><img src="/files/e2xoOJzxYnlpK82D5XWc" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

## Download a Bolt Schedule artifacts

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

### CLI command

```bash
paradime bolt artifact
```

### Options

| Flag              | Type                  | Description                                                                                                             |
| ----------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `--schedule-name` | *`Required, TEXT`*    | The name of the Bolt schedule                                                                                           |
| `--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" %}
{% hint style="info" %}
Get Bolt schedule `manifest.json` from the latest run.
{% endhint %}

**CLI command**

```
paradime bolt artifact --schedule-name "daily run"
```

**Example output**

<figure><img src="/files/zsbRRKate2zN8UUbtmOE" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Get Bolt schedule run\_results.json" %}
{% hint style="info" %}
Get Bolt schedule `run_results.json` from the latest run.
{% endhint %}

**CLI command**

```
paradime bolt artifact --schedule-name "daily run" --artifact-path target/run_results.json
```

**Example output**

<figure><img src="/files/R8xt5knOtjeCaegBdZ0S" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

## Bolt Schedules Suspend

{% hint style="danger" %}
YAML schedules **cannot** be "suspended" via the CLI.
{% endhint %}

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
paradime bolt schedule suspend "<schedule_name>"
```

### Examples

{% tabs %}
{% tab title="Suspend a Bolt Schedule" %}
**CLI Command**

```bash
paradime bolt schedule suspend "daily run"
```

**Example output**

<figure><img src="/files/NlRCpw3jpmuAl03O7PzJ" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

## Bolt Schedules Unsuspend

{% hint style="danger" %}
YAML schedules **cannot** be "unsuspend" via the CLI.
{% endhint %}

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](#bolt-schedules-suspend) CLI command.

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

### CLI Command

```bash
paradime bolt schedule unsuspend "<schedule_name>"
```

### Examples

{% tabs %}
{% tab title="Unsuspend a Bolt Schedule" %}
**CLI Command**

```bash
paradime bolt schedule unsuspend "daily run"
```

**Example output**

<figure><img src="/files/3soIyWOgJLf1F4nSk7LG" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

### CLI Command

```bash
paradime bolt schedule unsuspend "<schedule_name>"
```

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

<pre class="language-bash"><code class="lang-bash"><strong>paradime bolt verify
</strong></code></pre>

### 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" %}
{% hint style="info" %}
Verify the paradime\_schedules.yml file with the Bolt schedules configurations does not contain errors.
{% endhint %}

**CLI Command**

```bash
paradime bolt verify --path /workspace/repository/dbt/paradime_schedules.yml
```

**Example output**

<figure><img src="/files/DHmbKBLv66FzqJgjIYNm" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.paradime.io/app-help/developers-old/paradime-cli/bolt-cli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.