Quickstart Guide
Get started with Bugster CLI in under 5 minutes
This guide assumes you have already installed Bugster CLI. If not, please install it first.
Quick Setup
Get up and running with Bugster CLI in just a few commands.
1. Initialize Your Project & Authenticate
This command will:
- Prompt for your API key. You can find it in your Bugster dashboard.
- Create a
.bugsterdirectory for configuration and tests. - Ask for your application’s base URL (e.g.,
http://localhost:3000).
The base URL you provide is used for running tests locally or in your dev environment. If you set up GitHub integration, Bugster will automatically run tests on your Vercel preview deployments for each pull request.
2. (Recommended) Install the GitHub App for PR Previews
To get the most out of Bugster, connect your GitHub repository so Bugster can run tests automatically on every PR preview (e.g., Vercel deployments):
Open the Bugster Dashboard
Go to https://gui.bugster.dev and select your project.
Go to GitHub Integration
In the Overview page, find the “GitHub Integration” section and click Manage Integrations.
Install the GitHub App
Follow the prompts to install the Bugster GitHub App and grant access to the specific repository you want to connect.
Recommended: Install the Bugster GitHub App to enable automatic test runs on every Vercel preview for your pull requests. Go to the GitHub Integration section in the Overview page at gui.bugster.dev, click Manage Integrations, and grant access to your repository.
3. Generate Your First Tests
Bugster analyzes your codebase and creates test specifications in the .bugster/tests directory.
Use bugster generate --show-logs to see what Bugster discovers in your code.