Get started with Bugster CLI in minutes
This quickstart guide shows you how to set up Bugster CLI, create and run your first AI-powered tests in minutes.
After you complete this guide, you will have automated tests running against your web application.
Prerequisites: Before you begin, create a Bugster account and ensure you have a Next.js project ready.
You can get started with Bugster CLI in three simple steps:
bugster init
- Configure your project with authentication and settingsbugster generate
- AI analyzes your code and creates test specificationsbugster run
- Execute tests with browser automation against your applicationLet’s walk through each step:
First, install the Bugster CLI on your system.
Visit our installation guide for detailed setup instructions
Navigate to your project’s root directory and initialize Bugster:
This command sets up Bugster configuration for your specific project, creating the necessary files and folders to store your tests and settings.
During initialization, you’ll be prompted for:
Bugster API KEY
Get your API KEY in the dashboard.
This is a one-time configuration
Project Name
Recommendation: Use your GitHub repository name for consistency
Base URL
The localhost URL where your frontend application runs
Authentication Credentials
Required if your app has authentication
Add testing credentials for Bugster to log in and test your protected pages:
These credentials allow Bugster to test authenticated areas of your application.
Visit our init
guide for advanced options and customization
Create test specifications for your application using:
This command analyzes your codebase and automatically creates test specifications under each page. It understands your application structure and generates relevant test cases.
Visit our generate guide for advanced options and customization
Execute the generated tests against your application:
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.
Learn about test execution options and configurations
Connect Bugster to your GitHub repository for automated testing on pull requests.
The GitHub integration enables Bugster to automatically run tests on pull requests, providing immediate feedback on code changes and preventing regressions.
Access GitHub Integration
Visit the Bugster Dashboard and navigate to GitHub integration settings and click "Connect Organization"
.
Install the App
Select your organization or user account, then choose the repository you want to integrate with Bugster.
Visit github
integration for details and guidance on GitHub App Installation.
Enable Preview Access
If using Vercel or Railway you must grant Bugster permissions for previews
Commit Bugster Configuration with your changes
Add the .bugster
folder to your repository:
Create a Pull Request
Create a pull request to see Bugster in action. The GitHub app will automatically run your tests and report results.
Congratulations! You now have Bugster CLI set up and running. Here’s what to explore next:
Visit our generate guide for advanced options and customization
Learn about test execution options and configurations
Visit github
integration for details and guidance on GitHub App Installation.
Tests not generating
Ensure you’re in a Next.js project directory and that Bugster CLI is properly installed. Check the installation guide for requirements.
Tests failing to run
Verify your application is running on the configured base URL and that any required authentication credentials are correct.
GitHub integration not working
Make sure you’ve committed the .bugster
folder to your repository and that the GitHub app has proper permissions for your repository.
Need help? Visit our documentation or reach out to our support team through the Bugster Dashboard.