Skip to main content
The reqflo CLI lets you run journeys locally, trigger the Cloud Runner, and integrate API workflow execution into CI pipelines and automation. This page is a consolidated reference; see the CLI guides for usage walkthroughs and examples.

​
Commands

CommandDescription
reqflo loginAuthenticate with Reqflo. Opens a browser flow to log in and store credentials locally.
reqflo run <journey>Run a journey. Defaults to local execution unless --cloud is specified.
reqflo --helpShow top-level help. Append --help to any command for command-specific help.

​
reqflo login

reqflo login
Initiates the authentication flow. Once complete, your credentials are stored locally and used for all subsequent CLI commands. See Authenticate for details.

​
reqflo run

reqflo run <journey> [flags]
<journey> is the journey name or identifier. Runs the journey against the configured environment and case, using any values passed via flags.

​
Flags

FlagDescription
--env <name>Target environment to run against (e.g. sandbox, staging, production).
--case <name>Case to load for this run (e.g. "Happy path", "Expired token").
--set key=valuePass an individual value for this run. Repeatable. Overrides case and variable values.
--data <file>Path to a .csv or .json data file for data-driven parallel runs.
--reporter <format>Output format for the run report. Accepted values: json, junit.
--output <path>File path to write the report to (e.g. ./results/report.xml).
--cloudExecute the journey using the Cloud Runner instead of local execution.

​
Usage examples

​
Local run with an environment and case

reqflo run create-order --env staging --case "Happy path"

​
Pass individual values at run time

reqflo run create-order \
  --env staging \
  --set customer_id=cust_abc123 \
  --set product_sku=SKU-999

​
Data-driven parallel run from a CSV

reqflo run create-order --env staging --data ./test-data/orders.csv

​
Run in CI with JUnit output

reqflo run create-order \
  --env staging \
  --case "Happy path" \
  --reporter junit \
  --output ./test-results/reqflo.xml

​
Cloud Runner execution

reqflo run create-order --env production --case "Smoke test" --cloud

​
Combine flags for a full CI run

reqflo run payment-flow \
  --env staging \
  --case "Happy path" \
  --set customer_id=cust_test \
  --reporter json \
  --output ./results/payment-flow.json \
  --cloud

​
Flag behavior notes

FlagNotes
--setCan be repeated multiple times. Each --set overrides the named value for the current run only, taking priority over case values and variable defaults.
--dataCSV files must have a header row matching journey input names. JSON files should be an array of objects. Each row/object becomes a separate parallel run.
--reporterWhen omitted, output is printed to stdout in a human-readable format.
--outputWhen omitted, report output goes to stdout. Requires --reporter to specify a format.
--cloudSends the run to the Cloud Runner. Requires authentication (reqflo login) and a valid build artifact.