Skip to content
Vegha Docs

Quick Start

This walkthrough takes you from a fresh install to a saved, tested request. It should take about five minutes.

1. Create a workspace

Section titled “1. Create a workspace”

A workspace is just a folder on disk. When Vegha opens for the first time, choose New Workspace and pick (or create) an empty folder — for example ~/api-tests.

Everything you do lives inside that folder as plain-text files, so you can put it under git whenever you like. See Collections overview.

2. Send your first request

Section titled “2. Send your first request”

  1. Press Ctrl + T (⌘ T on macOS) to open a new request tab.

  2. Leave the method as GET and enter a URL:

    https://httpbin.org/get

  3. Press Ctrl + Enter (⌘ ↩) to send.

The response panel shows the status line (200 OK), the timing, the response size, and the body with syntax highlighting. The connection timeline breaks the request down into DNS, connect, TLS, and time-to-first-byte.

3. Save it to a collection

Section titled “3. Save it to a collection”
  1. Press Ctrl + S (⌘ S).
  2. Vegha asks for a collection. Create one — call it Demo — and give the request a name like Get example.

Vegha writes a Demo folder into your workspace containing a .bru file for the request. Open it in any text editor and you’ll see a readable, diffable representation of exactly what you configured.

4. Add a variable

Section titled “4. Add a variable”

Hard-coded URLs don’t scale. Let’s parameterize the host:

  1. Open the Environments panel from the activity rail.

  2. Create an environment called default with a variable:

    NameValue
    baseUrlhttps://httpbin.org

  3. Back in your request, change the URL to:

    {{baseUrl}}/get

  4. Make sure default is selected in the environment picker, then send again.

{{baseUrl}} is resolved at send time. See Variables & Environments.

5. Write a test

Section titled “5. Write a test”

Open the request’s Tests tab and add a post-response assertion:

test('responds 200', () => {
  expect(res.status).toBe(200);
});


test('echoes the host', () => {
  expect(res.body.headers.Host).toBe('httpbin.org');
});

Send the request again. The Test Results view reports both assertions passing. Tests run in a sandboxed JS engine — see Scripting & Tests.

6. Run the whole collection

Section titled “6. Run the whole collection”

You can run the entire Demo collection at once from the UI — or from your terminal with the bundled CLI:

Terminal window
vegha run ./Demo --env default

The CLI shares the exact same engine as the desktop app. See the CLI overview.

Where to go next

Section titled “Where to go next”