Initialize project
Set up Bugster CLI in your project and authenticate with your account
The bugster init
command initializes Bugster CLI in your project, handles authentication, and configures your project settings.
The init
command is the first step you must complete before using any other Bugster CLI features. It sets up authentication and creates your project configuration.
Basic Usage
This command will guide you through:
- Authentication (if first time)
- Project configuration
- Credential setup (for authenticated apps)
Step-by-Step Process
Navigate to your project
Open your terminal and navigate to your Next.js project’s root directory:
Run the init command
Execute the initialization command:
API Key Authentication (First Time Only)
If it’s your first time using Bugster CLI, you’ll be prompted for your API key:
Get Your API Key
Find your API key in the Bugster Dashboard under Account Settings
Configure Project Settings
You’ll be prompted to configure your project:
Project Name
Base URL
Authentication Credentials (if your app requires login)
What Gets Created
After running bugster init
, the following structure is created in your project:
Configuration File
The config.yaml
file contains your project settings:
Configuration Options
Project Name
Project Name
Purpose: Identifies your project in the Bugster dashboard
Recommendation: Use your GitHub repository name for consistency
Example: my-nextjs-app
Base URL
Base URL
Purpose: The URL where your application runs during testing
Common values:
http://localhost:3000
(Next.js default)http://localhost:3001
(custom port)https://staging.myapp.com
(staging environment)
Authentication Credentials
Authentication Credentials
Purpose: Test user credentials for authenticated areas of your app
When needed: If your app has login/authentication gates
Multiple credentials: You can add multiple test users for different scenarios
Security: Credentials are stored locally and used only for testing
Advanced Configuration
For advanced use cases, you can customize additional settings in your config.yaml
file:
Advanced Configuration
Learn about advanced configuration options including Vercel protection bypass, always-run tests, and more
Troubleshooting
Invalid API Key
Invalid API Key
Error: Authentication failed
Solutions:
- Double-check your API key in the Bugster dashboard
- Ensure you’re copying the entire key without extra spaces
- Verify you have an active internet connection
Existing Project Warning
Existing Project Warning
Error: Existing Bugster project detected
Solutions:
- Choose to reinitialize if you want to update settings
- Cancel if you want to keep existing configuration
Nested Project Error
Nested Project Error
Error: Cannot initialize nested Bugster project
Solution: Move to a directory outside of any existing Bugster project
Permission Denied
Permission Denied
Error: Cannot create .bugster directory
Solutions:
- Ensure you have write permissions in the current directory
- Run as administrator/sudo if necessary
Next Steps
After successful initialization, you’re ready to: