Quickstart

Get started with Bugster CLI in minutes

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. You’ll create your Bugster account during the setup process.

Choose Your Setup Method

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

Automatic Integration

Recommended for most users

Bugster creates a pull request with everything configured.

Manual Integration

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:

   Platform Selection

   Choose your deployment platform:

   • Vercel - For Vercel deployments
   • Railway - For Railway deployments

   Bypass Protection (Vercel)

   If using Vercel, configure bypass protection for preview deployments.

   Vercel Bypass Setup

   Learn how to configure bypass protection for Vercel deployments

   Testing Credentials

   If your application requires authentication, provide testing credentials.

   Authentication Configuration

   Learn about configuring authentication for testing

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!

Manual Integration

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

1. Install Bugster CLI

   First, install the Bugster CLI on your system.

   Install Bugster CLI

   Visit our installation guide for detailed setup instructions

2. Initialize Bugster in Your Project

   Navigate to your project’s root directory and initialize Bugster:

   cd your-nextjs-project
   bugster init
   

   This command sets up Bugster configuration for your specific project, creating the necessary files and folders to store your tests and settings.

   Configuration Setup

   During initialization, you’ll be prompted for:

   Bugster API KEY

   Get your API KEY from the Bugster Dashboard. This is a one-time configuration per project

   Project Name

   Recommendation: Use your GitHub repository name for consistency

   Project name: my-awesome-app
   

   Base URL

   The localhost URL where your frontend application runs

   Application URL: http://localhost:3000
   

   Bypass Protection

   Configure bypass protection for preview deployments (required for Vercel/Railway).

   Vercel Bypass Setup

   Learn how to configure bypass protection for Vercel deployments

   Authentication Credentials

   Required if your app has authentication Add testing credentials for Bugster to log in and test your protected pages:

   • Username/Email: test user credentials
   • Password: test user password

   Authentication Configuration

   Learn more about configuring authentication for testing

   Learn More About Project Initialization

   Visit our init guide for advanced options and customization

3. Generate Your First Tests

   Create test specifications for your application using:

   bugster generate
   

   This command analyzes your codebase and automatically creates test specifications under each page. It understands your application structure and generates relevant test cases.

   Learn More About Test Generation

   Visit our generate guide for advanced options and customization

4. Generate Your First 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

5. 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
   

6. Integrate GitHub App

   Connect Bugster to your GitHub repository for automated testing on pull requests.

   GitHub App Integration

   Visit our GitHub integration guide for detailed setup instructions

Next Steps

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

Generate More Tests

Want to create more tests for your app? Learn advanced test generation options and customization.

Adapt Bugster to your workflow

Want to customize when to execute tests and destructive testing? Configure your testing workflow.

Find & Fix Bugs

Want to find bugs and resolve them in your current version? Use our destructive testing agent.

Automate Test Updates

Want to automatically update your tests? Set up automated test maintenance in GitHub.