Connect your CLI to your Bugster account by initializing your project
Authentication is handled during project initialization. It is the first step you must complete before using any other Bugster CLI features.
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.
During the initialization process, you will be prompted to enter your Bugster API key.
Run the init command
Open your terminal and run bugster init
.
Get your API key
You can find your API key in your Bugster dashboard under the Account Settings section.
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.
Invalid API Key:
init
command will report an error. Double-check your API key in the Bugster dashboard and try running bugster init
again.Network Issues:
Once your project is initialized and you are authenticated, you’re ready to:
Start generating tests from your codebase.
Follow the full getting started guide
To enable automatic test runs on every Vercel preview for your pull requests, connect your GitHub repository:
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.