CLI Overview
Vegha ships with vegha, a command-line tool that runs your collections from a terminal or CI pipeline. It shares the same request engine as the desktop app, so a collection behaves identically whether you run it in the GUI, the terminal, or CI.
What the CLI is
Section titled “What the CLI is”The vegha binary executes the plain-text .bru collections in your workspace folder. Because there is one engine behind both the app and the CLI, there is no second runtime to configure and no behavioral drift between local testing and automated runs.
Installing the CLI
Section titled “Installing the CLI”The CLI is included with the Vegha desktop application — once the app is installed, the vegha binary is available alongside it. See Installation for platform details.
To build and run from source instead:
dotnet run --project cli -- <args>Listing the available verbs
Section titled “Listing the available verbs”Run vegha with no arguments to print the list of supported verbs:
veghaThe main verbs
Section titled “The main verbs”The CLI has two primary verbs:
| Verb | Purpose |
|---|---|
run | Execute a collection or folder of requests. See vegha run. |
import | Import an OpenAPI, Postman, Insomnia, Bruno, or WSDL file into a collection. See vegha import. |
Why it’s good for CI
Section titled “Why it’s good for CI”The CLI is designed for continuous integration:
- It produces JUnit XML, which any CI system that reads test results can consume.
- It exits with a non-zero status code when tests fail, so a failing run fails the pipeline.
- The shared engine guarantees that what passes locally passes in CI.
Next steps
Section titled “Next steps”- vegha run — execute collections and generate reports.
- vegha import — bring existing specs and collections into Vegha.