Skip to main content
The Reqflo CLI (reqflo) gives you copyable commands to run any journey outside the visual editor. Use it in a terminal, a CI job, a cron schedule, or any automation tool that can run a shell command. Everything you can configure in the editor — environments, cases, passed values, data files, reporting — is available as a flag.

​
When to use it

  • Local development — run a journey against a local or sandbox environment before pushing code.
  • CI/CD pipelines — assert that API workflows pass as part of your build or deploy gate.
  • Scheduled automation — trigger journeys on a schedule to catch regressions between deploys.
  • Scripted workflows — compose multiple journey runs in a shell script or Makefile.

​
Key concepts

Local vs. cloud execution. By default, reqflo run executes locally using your machine’s environment. Add --cloud to hand execution off to the Cloud Runner, which uses durable worker execution and cloud-managed secrets. Flags compose. A single reqflo run command can combine an environment, a case, one-off value overrides, a data file, and a reporter in any combination. The flags layer on top of each other in a well-defined resolution order. Authentication. Local runs don’t require authentication for public journeys, but cloud runs and anything that accesses private journeys or secrets requires you to be logged in via reqflo login.

​
How it works

  1. You identify the journey you want to run (by name or ID).
  2. You compose the flags you need — environment, case, values, data file, reporter.
  3. reqflo run <journey> compiles the journey into a build artifact and executes it locally, or sends the artifact to the Cloud Runner if --cloud is passed.
  4. Results stream to stdout (or your chosen reporter/output path).

​
CLI pages

Install

Install the reqflo binary on your machine.

Authenticate

Log in with reqflo login for cloud runs and private journeys.

Run a journey

The core reqflo run command, local and cloud.

Run with a case

Use a saved Case to autofill value configuration.

Run with an environment

Target a specific Environment (sandbox, staging, production).

Pass values

Override or supply run inputs with —set key=value.

Use data files

Drive parallel runs from a CSV or JSON data file.

Reporting flags

Control output format, file path, and reporter type.

CI examples

Practical GitHub Actions, GitLab CI, and scheduled-run examples.

Command reference

Full flag and subcommand reference.