Skip to main content
This page consolidates every reqflo command and flag for quick lookup. For detailed usage, examples, and context, see the linked per-topic pages. The full machine-readable reference is at /reference/cli-reference.

​
Commands

​
reqflo run <journey>

Execute a journey by name or ID.
FlagTypeDescription
--env <name>stringTarget a named Environment.
--case <name>stringLoad a saved Case for value configuration.
--set key=valuestring (repeatable)Supply or override a run input. Repeat for multiple values.
--data <file>pathPath to a CSV or JSON file for data-driven parallel runs.
--cloudbooleanExecute in the Cloud Runner instead of locally.
--reporter <format>junit | jsonOutput format for run results.
--output <path>pathWrite reporter output to a file instead of stdout.
Basic form: 
reqflo run <journey> [flags]
Full example: 
reqflo run my-journey \
  --env staging \
  --case "Happy path" \
  --set user_id=usr_test_42 \
  --cloud \
  --reporter junit \
  --output ./results/report.xml

​
reqflo login

Authenticate with Reqflo. Opens a browser for interactive OAuth. In non-interactive environments, use REQFLO_TOKEN or --token instead.
FlagTypeDescription
--token <token>stringAuthenticate using an API token (non-interactive).
reqflo login

​
reqflo logout

Clear the stored local session. 
reqflo logout

​
reqflo whoami

Print the currently authenticated account. 
reqflo whoami

​
reqflo --help

Print help for any command. 
reqflo --help
reqflo run --help

​
reqflo --version

Print the installed CLI version. 
reqflo --version

​
reqflo completion

Generate shell completion scripts. 
reqflo completion --help

​
Environment variables

VariableDescription
REQFLO_TOKENAPI token for non-interactive authentication. Takes precedence over stored credentials.

​
Exit codes

CodeMeaning
0All steps passed; no errors.
1One or more steps failed or assertions did not pass.
2Configuration error (bad flags, missing required input, etc.).

​
Flag precedence for value resolution

When multiple sources supply a value for the same key, the CLI resolves them in this order (highest wins):
  1. --set key=value (CLI override)
  2. Case values (--case)
  3. Environment values (--env)
  4. Journey variable presets and defaults
See Value resolution order for the full details.

Run a journey

Core command usage and options.

CI examples

GitHub Actions, GitLab CI, and scheduled run patterns.

Full CLI reference

Machine-readable flag and schema reference.

Authenticate

Login, tokens, and CI authentication.