Skip to main content

CLI Command Reference

This document covers all available subcommands and flags in the Rumour CLI, complete with examples of how to utilize them.

Built-in Shell Completions​

Rumour features a built-in shell completion generation script that supports Bash, Zsh, Fish, PowerShell, and Elvish. When enabled, pressing Tab inside your terminal will instantly suggest all available commands, options, and flags.

Activating Completions​

You can generate and source the completions instantly on the fly:

1. Zsh​

Add the following line to your ~/.zshrc file:

source <(rumour completions zsh)

2. Bash​

Ensure you have bash-completion installed, then add this line to your ~/.bashrc file:

source <(rumour completions bash)

3. Fish​

To add permanent completion in Fish shell, execute:

rumour completions fish > ~/.config/fish/completions/rumour.fish

Subcommand Dictionary​

1. rumour run​

Executes individual request .toml nodes or complete directory suites.

rumour run <path_to_file_or_dir> [flags]

Common Flags:

  • -p, --parallel — Enables multi-threaded run execution using dependency level hierarchies.
  • -c, --concurrency <LIMIT> — Caps the maximum concurrent TCP connections during parallel runs.
  • -H, --heal — Runs in dynamic self-healing mode for transient failure recovery.
  • -X, --hard-heal — Automatically reconstructs missing (404) resources by finding their creator nodes.
  • -i, --interactive — Enables interactive terminal prompts upon node failure (Retry/Skip/Abort).
  • --data <FILE> — Iterates the execution against a provided CSV or JSON data file.
  • --junit <FILE> — Generates a pipeline-compatible JUnit XML test report.
  • -e, --env-file <FILE> — Explicitly overrides the default workspace.env.toml.
  • -V, --var <KEY=VAL> — Overrides a runtime variable via the CLI.
  • -C, --auto-cleanup — Automatically issues teardown requests at the end of the suite to clean up test data.
  • --list-nodes — Performs a dry-run discovery, listing all parsed .toml nodes.
  • --vars — Performs a pre-flight variable resolution check and outputs the runtime memory state.

2. rumour doc​

Analyzes your .toml files and generates a beautiful markdown document with an embedded Mermaid.js architecture graph illustrating your endpoints and variables.

rumour doc <path> --output documentation.md

3. rumour graph​

Outputs just the raw Mermaid graph code for your workflow dependencies, without the surrounding Markdown documentation.

rumour graph <path> > graph.mmd

4. rumour watch​

Listens for local workspace edits on your .toml files and triggers hot-reload sequence executions automatically. Great for rapid prototyping.

rumour watch <path>

5. rumour bench​

Runs micro-benchmarks on target endpoints to measure performance metrics under parallel loads.

rumour bench <path> -n 1000 -c 100

(Runs 1,000 iterations with 100 concurrent workers)

6. rumour import​

Migrates existing API test collections from Postman or Bruno into the Rumour workspace structure.

rumour import --format postman --input ./collection.json --output ./imported_workspace

7. rumour export​

Zips up a specific Rumour test directory and strips sensitive secrets so it can be safely shared with team members.

rumour export --input ./my_api_tests --output tests.zip

8. rumour vault​

Manages the encrypted local .rumour/vault.enc for storing secret tokens without exposing them to source control.

rumour vault <action>
  • set <key> <val> — Securely registers a secret key-value.
  • get <key> — Retrieves a decrypted value.
  • list — Displays all key names (does not require password verification).
  • delete <key> — Deletes a secret from the vault.
  • rekey --old <old_pass> --new <new_pass> — Changes the master password of the vault and re-encrypts all secrets.
  • reset — Permanently purges and deletes the vault file and all secrets.
caution

Password Recovery: The vault is securely encrypted using AES-256-GCM. There is no backdoor, recovery key, or way to retrieve password-protected secrets if the master password is forgotten. If you lose your password, rumour vault reset is the only way to restore vault functionality by purging the old vault file, though all previously stored secrets will be permanently lost.

9. rumour init​

Bootstraps a clean, zero-clutter workspace.env.toml and .gitignore file in the current directory.

rumour init

10. rumour new​

Scaffolds a basic GET request .toml template.

rumour new my_request.toml

11. rumour completions​

Prints shell autocomplete integration scripts directly to standard output.

rumour completions <shell>

Supported values for <shell>: bash, zsh, fish, powershell, elvish.