Bugster project dashboard showing testing statistics and next steps
This quickstart guide shows you how to set up Bugster CLI and create your first AI-powered tests in minutes. After you complete this guide, you will have automated tests running against your web application and integrated with your GitHub workflow.
Prerequisites: Before you begin, ensure you have:
  • A Next.js project ready
  • A Bugster account created at bugster.dev

Choose Your Setup Method

Bugster offers two ways to get started. Choose the method that best fits your workflow:

Manual Integration

For users who prefer CLI control or need custom configurations, follow this manual setup process.
1

Install Bugster CLI

2

Initialize Bugster and Generate Tests

Navigate to your project’s root directory and run the quickstart command:
cd your-nextjs-project
bugster quickstart --api-key=YOUR_API_KEY
Get your API KEY from the Bugster Dashboard.What this command does:
  • Sets up Bugster configuration for your project
  • Creates necessary files and folders
  • Analyzes your codebase and automatically generates test specifications
  • Stores tests in .bugster/tests directory
Configuration Prompts:During setup, you’ll be prompted for:
  • Application URL: The localhost URL where your frontend application runs (defaults to http://localhost:3000)
The quickstart command combines initialization and test generation in a single step, making setup faster and simpler.

Learn More About Advanced Configuration

For authentication credentials, bypass protection, and other advanced options
3

Run Your Tests

Execute the generated tests against your application:
bugster run
This command executes your test specifications in a browser, validating the instructions in the test specification.
Make sure your application is running on the configured base URL before running tests.

Advanced Test Execution

Learn about test execution options and configurations
4

Commit Configuration to Repository

Add the Bugster configuration to your repository:
git add .bugster/
git commit -m "Add Bugster CLI configuration"
git push origin main

Automatic Integration

The automatic integration is the fastest way to get started. It begins after account creation and guides you through a seamless setup process.

How It Works

After signing up at Bugster, you’ll be taken through an automated onboarding flow that:
1

Create Account & Connect GitHub

Sign up at Bugster and you’ll be automatically directed to the GitHub integration screen. Click “Connect GitHub Organization” to link your GitHub account.
2

Select Your Repository

Choose the Next.js repository you want to integrate with Bugster from your available repositories.
Repository Requirements: Your repository must be a Next.js project for automatic integration.
3

Configure Project Settings

Fill in your project information:
4

Receive Configuration Pull Request

After completing the setup (usually within a few minutes), you’ll receive a pull request with:
  • Complete Bugster CLI configuration
  • Generated test specifications
  • GitHub Actions workflow
  • All necessary project files
Simply review and merge the pull request to activate Bugster testing!

Next Steps

Congratulations! You now have Bugster set up and running. Here’s what to explore next: