With the desktop app & CLI
Vegha comes in three forms that run one engine:
| Where | Best for | |
|---|---|---|
| Vegha for VS Code | inside your editor | working on APIs next to the code that serves or calls them |
| Vegha desktop app | native app for Windows, macOS, Linux | a dedicated API workbench, native git UI, OpenAPI sync |
vegha CLI | your terminal and CI | running collections headlessly, JUnit output in pipelines |
Because the engine is the same, a request sends, authenticates, runs scripts and passes or fails the same way in each.
What’s shared
Section titled “What’s shared”- Collections. They’re
.brufiles on disk. Open the same folder in the desktop app and the extension and both see the same requests. - History, cookies and secret-manager configuration. By default the extension uses the
desktop app’s data folder, so a request you sent in one shows up in the other’s history.
Set
vegha.dataDirectoryto keep them apart.
You don’t need the desktop app
Section titled “You don’t need the desktop app”The extension bundles its own engine. Install the desktop app only if you want it. It’s free and MIT-licensed at vegha.ai.
Running collections in CI
Section titled “Running collections in CI”Collections you build in VS Code run unchanged with the CLI:
vegha run ./collections/orders --env staging --reporter junit --out results/junit.xmlSee the CLI docs for options. To try a run first, use the collection runner and export the same JUnit report.