Execution CLI
The Execution CLI lets you manage executions directly from your terminal. This is especially useful for CI/CD pipelines where you need to create, trigger, and monitor test runs without opening a browser.
Two Modes
The CLI supports two modes of operation:
- Interactive mode: a step-by-step menu that guides you through each action. Best for ad-hoc tasks and exploring available executions.
- Non-interactive mode: flag-based commands that produce machine-readable output. Best for scripting, CI/CD, and automation.
Getting Started
Launch the CLI with:
bash
npx blinqio-executions-cliIn interactive mode, you will first be prompted to authenticate using your BlinqIO access token. After authentication, a menu presents the available actions:
- View active executions
- Show all executions
- Create new execution from YAML
- Trigger an execution
- Stop an execution
- View completed executions
- Exit
Non-Interactive Mode
For scripting and CI/CD, run the CLI with explicit flags:
bash
npx blinqio-executions-cli --mode=MODE [options]Modes
| Mode | Description |
|---|---|
create | Create a new execution from a YAML configuration file |
startRun | Trigger an existing execution to run immediately |
stopRun | Stop a running execution |
getAll | List all executions in the project |
getActive | List only the currently active (running) executions |
getHistory | List completed executions and their results |
Options
| Option | Description |
|---|---|
--token | Your BlinqIO access token for authentication |
--filePath | Path to the YAML file used when creating an execution |
--executionId | The ID of the execution to target (for start, stop, and history) |
--executionName | Filter or name executions by a human-readable label |
--debug | Enable verbose output for troubleshooting |
-h | Display the help menu with all available options |
Examples
Create an execution from YAML
bash
npx blinqio-executions-cli --mode=create --token=YOUR_TOKEN --filePath=./my-execution.yamlTrigger an execution
bash
npx blinqio-executions-cli --mode=startRun --token=YOUR_TOKEN --executionId=abc123Stop a running execution
bash
npx blinqio-executions-cli --mode=stopRun --token=YOUR_TOKEN --executionId=abc123TIP
Store your access token in an environment variable (e.g., BLINQIO_TOKEN) to avoid passing it on every command and to keep it out of your shell history.
