Bolt CLI

• This feature is available with the Paradime Bolt plan.

• Your API keys must have either Bolt Schedules Admin or Bolt Schedules Metadata Viewer capabilities.

Trigger a Bolt Run

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

CLI command

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

Trigger Bolt schedule run and wait for status

Trigger a Bolt schedule run, and return the status until is completed.

CLI command

paradime bolt run "daily run" --wait

Example output

Trigger Bolt schedule run with command override

Trigger Bolt schedule run with git branch override

Download a Bolt Schedule artifacts

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

CLI command

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

Get Bolt schedule manifest.json

Get Bolt schedule manifest.json from the latest run.

CLI command

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

Example output

Get Bolt schedule run_results.json

Bolt Schedules Suspend

YAML schedules cannot be "suspended" via the CLI.

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

paradime bolt schedule suspend "<schedule_name>"

Examples

Suspend a Bolt Schedule

CLI Command

paradime bolt schedule suspend "daily run"

Example output

Bolt Schedules Unsuspend

YAML schedules cannot be "unsuspend" via the CLI.

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

paradime bolt schedule unsuspend "<schedule_name>"

Examples

Unsuspend a Bolt Schedule

CLI Command

paradime bolt schedule unsuspend "daily run"

Example output

CLI Command

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

paradime bolt verify

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

Verify paradime_schedules.yml file

Verify the paradime_schedules.yml file with the Bolt schedules configurations does not contain errors.

CLI Command

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

Example output