The Bugster CLI provides a comprehensive set of commands for project setup, test generation, execution, and synchronization. Here are all available commands:
Analyze your codebase to automatically generate comprehensive test specifications.
Copy
bugster generate [OPTIONS]
Options:
--show-logs - Show detailed logs during the analysis process
--force, -f - Force analysis even if codebase has already been analyzed (overrides cache)
What it does:
Scans your codebase to understand application structure
Identifies testable components and functionality
Generates comprehensive test specifications using AI
Creates test files in the .bugster/tests directory
Uses intelligent code pattern recognition
Examples:
Copy
# Basic test generationbugster generate# Generate tests with detailed loggingbugster generate --show-logs# Force re-analysis of already analyzed codebasebugster generate --force
Example generated test:
Copy
- name: Checkout Process Test task: Verify that users can complete the checkout process expected_result: Order should be successfully placed steps: - Navigate to /products page - Add a product to the cart - Navigate to /cart page - Verify product is in the cart - Click "Proceed to Checkout" button - Fill in shipping information - Select shipping method - Enter payment information - Review order summary - Click "Place Order" button - Verify order confirmation page is displayed
Run your Bugster tests with various execution modes and output options.
Copy
bugster run [PATH] [OPTIONS]
Arguments:
PATH - Optional path to test file or directory (defaults to .bugster/tests)
Options:
--headless - Run tests in headless mode (for browser-based tests)
--silent, -s - Run in silent mode with less verbose output
--stream-results - Stream test results as they complete (real-time output)
--output FILE - Save test results to a JSON file
--run-id ID - Associate a specific run ID with the test execution
--base-url URL - Override the base URL for the test run
Examples:
Copy
# Run all testsbugster run# Run tests in headless modebugster run --headless# Run specific test file silentlybugster run tests/login.spec.js --silent# Run with real-time output and save resultsbugster run --stream-results --output results.json# Run tests against staging environmentbugster run --base-url https://staging.example.com# Run specific test directory with custom run IDbugster run integration_tests/ --run-id "release-v1.2.3"
What happens during execution:
Loads configuration from .bugster/config.yaml
Finds and loads test files (YAML/JSON format)
For each test case, the Bugster Agent:
Opens a browser and performs test steps
Executes each step in sequence
Validates results against expected outcomes
Determines pass/fail status
Displays summary table with results (Test Name, Result, Reason, Time)
Update your test specifications based on the latest changes in your codebase.
Copy
bugster update [OPTIONS]
Options:
--update-only - Only update existing specs, skip suggestions and deletions
--suggest-only - Only suggest new specs, skip updates and deletions
--delete-only - Only delete obsolete specs, skip updates and suggestions
--show-logs - Show detailed logs during the update process
What it does:
Detects changes in your codebase since last analysis
Updates existing test specifications to match code changes
Suggests new tests for new functionality
Identifies and removes obsolete test specifications
Maintains test coverage as your code evolves
Examples:
Copy
# Full update: modify, suggest, and delete specsbugster update# Only update existing test specificationsbugster update --update-only# Only suggest new tests with loggingbugster update --suggest-only --show-logs# Only remove obsolete specificationsbugster update --delete-only
Synchronize your local test specifications with the remote Bugster platform for team collaboration.
Copy
bugster sync [OPTIONS]
Options:
--branch BRANCH - Specify branch to sync with (defaults to current git branch or ‘main’)
--pull - Only pull specs from remote (download only)
--push - Only push specs to remote (upload only)
--clean-remote - Delete remote specs that don’t exist locally
--dry-run - Show what would happen without making actual changes
--prefer CHOICE - Prefer ‘local’ or ‘remote’ when resolving conflicts
What it does:
Synchronizes test specifications between local and remote
Handles branch-specific test data
Resolves conflicts between local and remote versions
Enables team collaboration on test specifications
Provides backup and versioning for your test data
Examples:
Copy
# Full bidirectional syncbugster sync# Sync with specific branchbugster sync --branch feature/new-ui# Only download specs from remotebugster sync --pull# Preview upload without making changesbugster sync --push --dry-run# Resolve conflicts preferring local versionsbugster sync --prefer local# Clean up remote specs not present locallybugster sync --clean-remote
# 1. Initialize project and authenticate (FIRST STEP)bugster init# 2. Generate initial test specsbugster generate# 3. Run the generated testsbugster run
Development Cycle
Copy
# 1. Make code changes# [Your development work]# 2. Update tests for code changesbugster update# 3. Verify tests still passbugster run# 4. Sync with team/remotebugster sync
Team Collaboration
Copy
# 1. Get latest team test specsbugster sync --pull# 2. Work on features# [Your development work]# 3. Update tests for your changesbugster update# 4. Share your test updatesbugster sync --push
Debugging Failed Tests
Copy
# 1. Run tests with detailed loggingbugster run --show-logs# 2. Run specific failing testbugster run path/to/failing_test.yml --stream-results# 3. Check test in non-headless modebugster run path/to/failing_test.yml# 4. Save results for analysisbugster run --output debug_results.json
If you entered an incorrect API key, run bugster init again to re-authenticate.
Check network connectivity to Bugster servers
Configuration Issues:
Check .bugster/config.yaml for syntax errors
Reinitialize if corrupted: bugster init
Test Execution Failures:
Use --show-logs for detailed debugging information
Verify base URL is accessible: --base-url option
Check browser dependencies for headless mode
Debug Commands
Copy
# Get detailed logs during any operationbugster [command] --show-logs# Preview sync changes without applyingbugster sync --dry-run# Force bypass cache issuesbugster generate --force# Run tests with full outputbugster run --stream-results
Reset and Recovery
Copy
# Reinitialize project (this also allows re-authentication)bugster init# Force regenerate all testsbugster generate --force# Clean remote sync statebugster sync --clean-remote --dry-run # preview firstbugster sync --clean-remote # then execute