Skip to main content

courier-runner reference

Reference for the courier-runner command.

Syntax

If the courier-runner Habitat package is binlinked in your system’s PATH, you can run the executable directly:

courier-runner [FLAGS]

If the courier-runner Habitat package isn’t binlinked in your system’s PATH, prefix commands with hab pkg exec chef-platform/courier-runner to execute Courier Runner commands:

hab pkg exec chef-platform/courier-runner courier-runner [FLAGS]

Description

Courier Runner is the courier-runner binary distributed as a Habitat package. Run it without flags to start in standard mode, or combine the --zero, --job-file/--stdin, and --dry-run flags to execute or validate a job locally.

Options

--config
Path to an alternate configuration file.

Type: string

Default: ~/.courier/config.yaml

-v, --verbose
Increases logging verbosity. Stack multiple flags (such as -vvv) for maximum detail.

Type: count

Default: 0

--zero
Enables zero mode for local, standalone job execution without a message queue.

Type: boolean

Default: false

--job-file
Path to a local JSON job run template file. Requires --zero. Mutually exclusive with --stdin.

Type: string

Default: ""

--stdin
Reads the JSON job run template from standard input. Requires --zero. Mutually exclusive with --job-file.

Type: boolean

Default: false

--output-dir
Base directory where zero mode saves job reports and evidence artifacts.

Type: string

Default: ~/.courier/zero-mode/runs

--dry-run
Validates the job template without executing steps or persisting state. Requires --zero.

Type: boolean

Default: false

Examples

Run a Courier job using a local file:

courier-runner --job-file <COURIER_JOB_FILE>

In zero mode, you can pipe a Courier job file from standard input:

cat job.json | courier-runner --zero --stdin

Save reports to a custom output directory:

courier-runner --output-dir /tmp/courier-reports

Thank you for your feedback!

×