Run Executions From The CLI

The Executions CLI lets you trigger, stop, and manage test executions directly from your terminal, which is ideal for automation pipelines, CI/CD workflows, or quick local runs. You can use it in interactive mode (guided menu) or non-interactive mode (custom scripts and flags).

Launch The Execution CLI

The Executions CLI runs directly in your terminal, so no setup or installation is required.

To launch the CLI, use:

npx blinqio-executions-cli

On your first run, you’ll see a message like:

Press y to continue. The CLI launches in interactive mode by default once you install it.

View CLI Help

To view all available commands, modes, and options, run:

npx blinqio-executions-cli --help

or simply,

npx blinqio-executions-cli -h

This opens a complete list of supported modes (like create, startRun, etc.), available flags, and usage examples. Use it to understand how to run the CLI in interactive or non-interactive mode.

Interactive Mode

Use the interactive CLI when you prefer a step-by-step interface to create, run, or manage executions without memorizing command-line flags.

1. Launch the CLI

npx blinqio-executions-cli

2. Authenticate

The CLI prompts you to enter your project's access token, allowing it to connect to your project and fetch execution data.

After you paste the access token and press Enter, the CLI checks if the token is valid. If it is, you’ll move to the next step.

3. Use the Menu

After authentication, you'll see a menu like:

Use the arrow keys to navigate and Enter to select.

View Active Executions

Lists all currently running executions in your project.

Show All Executions

Displays both running and completed executions.

Create a New Execution

You can create a new execution by supplying a YAML-based configuration file. This allows advanced setups including:

• Multiple flows
• Multiple scenario groups with tags
• Scheduled runs (daily or weekly)

When you choose "Create a New Execution" from the CLI menu, you'll get these options:

• Enter path to an execution configuration file

  If you already have a YAML config, enter the full path when prompted. Make sure the file follows the structure defined in executionTemplate.yaml.

• Download a template file

  The CLI can auto-generate a starter executionTemplate.yaml in your current directory. Edit this template to suit your needs.

• Cancel Exit the flow and return to the main menu.

  

Trigger a New Execution

Starts a run from an existing saved execution configuration.

Stop a Running Execution

Let's you select an active execution to stop.

View Completed Executions

Shows the list of the last five executions from your project.

Exit

Closes the CLI session.

Non-Interactive Mode

Use this mode for scripting or automation in CI/CD environments. Here’s the syntax:

npx blinqio-executions-cli [--mode=MODE] [options]

Use one of the following modes to define what action the CLI should perform in non-interactive mode:

Mode	Description
create	Create a new execution configuration from a YAML file
startRun	Trigger a new run for an existing execution
stopRun	Stop a running execution
getAll	Show all execution configurations
getActive	View currently active executions
getHistory	Show completed executions

These options are used alongside the mode to provide required inputs or modify behavior:

Option	Description
--token=TOKEN	Required. Your project's access token
--filePath=FILE	Path to YAML file (used with --mode=create)
--executionId=ID	ID of the execution to start or stop
--executionName=NAME	Name of the execution to start or stop
--debug=true	Enable verbose debug output
-h, --help	Show help information

Examples

Create a new execution configuration:

npx blinqio-executions-cli --mode=create --token=YOUR_ACCESS_TOKEN --filePath=./path/to/execution.yaml

Trigger a run for an existing execution:

npx blinqio-executions-cli --mode=startRun --token=YOUR_ACCESS_TOKEN --executionId=123

Stop a running execution:

Note

Terminating a running execution by name is not supported since there can be multiple running executions with the same name.

npx blinqio-executions-cli --mode=stopRun --token=YOUR_ACCESS_TOKEN --executionId=123