​
Bugster CLI Overview

The Bugster CLI is a powerful AI-powered command-line tool designed to generate, execute, and maintain end-to-end tests for web applications. It provides an intuitive interface to interact with the Bugster platform directly from your development environment.

​
Installation

Before using the Bugster CLI, you’ll need to install it. See the installation guide for detailed instructions for your operating system.

​
Available Commands

The CLI includes the following commands:
CommandDescription
authConfigure and manage your Bugster API key for CLI authentication
initSet up Bugster CLI in your project and authenticate with your account
generateGenerate AI-powered tests from your codebase
runExecute your test specifications with browser automation
updateKeep your tests synchronized with code changes
destructiveRun AI-powered destructive agents to find potential bugs

​
Getting Help

For help with any command, use the --help flag: 
bugster --help              # General CLI help
bugster init --help         # Help for the init command
bugster generate --help     # Help for the generate command

​
Command Syntax

The Bugster CLI follows a consistent command structure: 
bugster <command> [options]
Most commands accept various options that modify their behavior. These options are typically provided using the --option-name value format or boolean flags like --headless.

​
Workflow Example

A typical workflow with the Bugster CLI might look like:
  1. Authenticate: bugster auth
  2. Initialize project: bugster init
  3. Generate tests: bugster generate
  4. Run tests: bugster run
  5. Update tests: bugster update (after code changes)
  6. Advanced testing: bugster destructive (before releases)

​
Command Categories

​
Setup Commands

Essential commands for initial project configuration:

Authentication

Configure your API key and authenticate with Bugster

Project Setup

Initialize Bugster in your repository with configuration

​
Core Testing Workflow

Commands you’ll use regularly in your development process:

Generate Tests

AI-powered test generation from your codebase

Execute Tests

Run tests with automated browser instances

Maintain Tests

Keep tests synchronized with code changes

​
Advanced Testing

Specialized testing capabilities for comprehensive validation:

Destructive Testing

AI agents that find bugs through edge cases and unexpected behavior

​
Best Practices

Start with bugster auth and bugster init to set up your project. Then use bugster generate to create your initial test suite.
For the best experience, run bugster update after making code changes and bugster run --only-affected to validate your modifications.