Getting Started

~10-minute setup · Requires Node.js 18+ or Docker

Install the CLI

Install the BotGauge CLI globally via npm:

npm install -g @botgauge/cli

Or run via Docker without a global install:

docker run --rm -it botgauge/cli:latest --help

Verify your installation:

botgauge --version
# botgauge/1.8.0 linux-x64 node-v20.11.0

Connect your repo

Authenticate BotGauge with your Git host. Run the login command and follow the OAuth prompt:

botgauge login

# Opens browser for OAuth
# Supports: GitHub, GitLab, Bitbucket
# Token stored in ~/.botgauge/credentials

Then initialize BotGauge in your project root:

cd my-project
botgauge init

# Creates botgauge.config.json
# Detects project type (Next.js / Express / Rails / etc)
# Maps initial UI flows from your routing config

Run your first test

Point BotGauge at your running dev server and let it crawl your app:

botgauge crawl --url http://localhost:3000

# Agent maps 47 UI flows
# Generates test cases in .botgauge/tests/
# Shows coverage summary

Then run the generated tests:

botgauge run

# Starts parallel test execution
# Results in terminal + .botgauge/results/latest.json
# Self-healing kicks in for failing selector matches

View results

After your run completes, view detailed results in the BotGauge dashboard:

botgauge open
# Opens https://app.botgaugex.com/results/<run-id>

Or view the local JSON summary:

cat .botgauge/results/latest.json | jq '.summary'
# { "total": 47, "passed": 46, "failed": 0, "healed": 1 }

Next step: CI/CD integration — run your test suite on every pull request without manual trigger.