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

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

​
Security Best Practices

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.