Authenticate with API Key

Configure and manage your Bugster API key for CLI authentication

The bugster auth command manages authentication for Bugster CLI by configuring your API key. This command handles setting, updating, and clearing your API key credentials.

Authentication is required for all Bugster CLI operations. Your API key connects the CLI to your Bugster account and enables access to testing features.

Basic Usage

bugster auth

This command will guide you through the interactive authentication process, including opening the dashboard to retrieve your API key.

Command Options

Set API Key Directly

bugster auth --api-key "bugster_your_api_key_here"

Authenticate with a specific API key without interactive prompts.

Clear Existing API Key

bugster auth --clear

Remove the currently stored API key from your configuration.

Step-by-Step Process

1. Start Authentication

   Run the auth command in your terminal:

   bugster auth
   

2. Open Dashboard (Optional)

   The CLI will ask if you want to open the Bugster Dashboard:

   🌐 Would you like to open the Bugster Dashboard to get your API key? (y/n): y
   

   Selecting “y” will automatically open your browser to the dashboard.

3. Retrieve API Key

   Get Your API Key

   Find your API key in the Bugster Dashboard under Account Settings

   Your API key will look like: bugster_abc123xyz789...

4. Enter API Key

   Paste your API key when prompted:

   🔑 Paste your API key here: bugster_your_api_key_here
   

5. Validation & Storage

   The CLI will:

   • Validate your API key format
   • Test the key with Bugster servers
   • Save it securely for future use

   🔄 Validating API key...
   ✅ API key saved successfully!
   

Configuration Storage

Your API key is stored securely in your user configuration:

macOS/Linux: ~/.config/bugster/config.yaml

The configuration file structure:

apiKey: "bugster_your_api_key_here"

Advanced Usage

Non-Interactive Authentication

For CI/CD environments or automated scripts:

# Set API key from environment variable
bugster auth --api-key "$BUGSTER_API_KEY"

# Set API key directly
bugster auth --api-key "bugster_your_api_key_here"

Managing Multiple Accounts

To switch between different Bugster accounts:

# Clear current key
bugster auth --clear

# Set new API key
bugster auth --api-key "bugster_different_account_key"

Environment Variable Support

You can also use environment variables instead of storing the API key:

export BUGSTER_API_KEY="bugster_your_api_key_here"

Environment variables take precedence over stored configuration files.

Troubleshooting

Invalid API Key Format

Error: API keys typically start with ‘bugster_’

Solutions:

• Verify you copied the complete API key from the dashboard
• Ensure no extra spaces or characters were included
• Check that the key starts with bugster_

API Key Validation Failed

Error: Invalid API key. Please check and try again.

Solutions:

• Verify the API key is active in your dashboard
• Check your internet connection
• Ensure the API key hasn’t been revoked or expired
• Try generating a new API key from the dashboard

Permission Denied

Error: Cannot save configuration file

Solutions:

• Ensure you have write permissions to your home directory
• Check available disk space
• On Windows, try running as administrator
• On macOS/Linux, check file permissions for ~/.config/bugster/

Configuration File Issues

Error: Cannot read/write config file

Solutions:

• Delete the existing config file and re-authenticate
• Check file permissions on the configuration directory
• Ensure the directory structure exists

Security Best Practices

API Key Security

• Never share your API key publicly or commit it to version control
• Regenerate keys if you suspect they’ve been compromised
• Use environment variables in CI/CD environments
• Clear keys from shared machines after use

Team Environments

• Each team member should use their own API key
• Use service accounts for shared CI/CD environments
• Regularly audit and rotate API keys
• Monitor API key usage in the dashboard

Related Commands

After authentication, you can proceed with:

Initialize Project

Set up Bugster configuration in your project

Generate Tests

Create AI-powered test specifications from your codebase

Run Tests

Execute your Bugster tests

GitHub Integration

Connect your repository for automated testing

API Key Management

Need a new API key? Visit the Bugster Dashboard to generate or manage your API keys.

Lost access? If you can’t access your dashboard or need to reset your account, contact support through the Bugster Dashboard.