Authentication is handled during project initialization. It is the first step you must complete before using any other Bugster CLI features.

​
How to Authenticate

To authenticate the Bugster CLI, you need to run the init command. This command will guide you through setting up your project and connecting to your Bugster account. 
bugster init
During the initialization process, you will be prompted to enter your Bugster API key.

​
Step-by-Step Guide

1

Run the init command

Open your terminal and run bugster init.
bugster init
2

Get your API key

You can find your API key in your Bugster dashboard under the Account Settings section.
3

Enter your API key

Paste your API key when prompted by the CLI and press Enter. The CLI will validate the key and store it securely for future use.

​
Troubleshooting

Invalid API Key:
  • If you enter an invalid key, the init command will report an error. Double-check your API key in the Bugster dashboard and try running bugster init again.
  • Make sure you are copying the entire key without any extra spaces.
Network Issues:
  • The CLI needs to connect to Bugster servers to validate the API key. Ensure you have an active internet connection.

​
Next Steps

Once your project is initialized and you are authenticated, you’re ready to:

Generate Tests

Start generating tests from your codebase.

Quick Start

Follow the full getting started guide
To enable automatic test runs on every Vercel preview for your pull requests, connect your GitHub repository:
1

Open the Bugster Dashboard

Go to https://gui.bugster.dev and select your project.
2

Go to GitHub Integration

In the Overview page, find the “GitHub Integration” section and click Manage Integrations.
3

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.