🐛 Bugster Agent - Simple Browser testing
Bugster CLI generate comprehensive test specs for your web applications and keep them synchronized across your team. Minimal setup.
✨ AI-Powered Test Generation: Automatically analyze your codebase and generate comprehensive test specs
🎯 Intelligent Updates: Automatically update test specs when your code changes
🚀 Cross-Platform: Works on Windows, macOS, and Linux
🌐 Framework Support: Currently supports Next.js applications
📊 Dashboard Integration: Stream results to the Bugster dashboard for team visibility
Our installers automatically check for and install dependencies (Python 3.10+, Node.js 18+, Playwright).
curl -sSL https://github.com/Bugsterapp/bugster-cli/releases/latest/download/install.sh | bash -s -- -y- Download install.bat
- Right-click and select "Run as administrator"
If you already have Python 3.10+ and Node.js 18+ installed:
curl -sSL https://raw.githubusercontent.com/Bugsterapp/bugster-cli/main/scripts/install.py | python3- Python 3.10+: Required for the CLI core functionality
- Node.js 18+: Required for Playwright browser automation
- Playwright: Automatically installed during setup
-
Initialize your project
bugster init
-
Generate test cases
bugster generate
-
Run your tests
bugster run
-
Keep tests up to date
bugster update
Initialize Bugster CLI configuration in your project. Sets up authentication, project settings, and test credentials.
bugster initAnalyze your codebase and generate AI-powered test specs. This command scans your application structure and creates comprehensive test cases.
bugster generate [options]
Options:
-f, --force Force analysis even if already completed
--show-logs Show detailed logs during analysisExecute your Bugster tests with various options for different environments.
bugster run [path] [options]
Arguments:
path Path to test file or directory (optional)
Options:
--headless Run tests in headless mode
--silent Run in silent mode (less verbose output)
--stream-results Stream test results to dashboard
--output FILE Save test results to JSON file
--base-url URL Override base URL for testing
--only-affected Only run tests affected by recent changes
--max-concurrent N Maximum concurrent tests (up to 5)
--verbose Show detailed execution logsExamples:
# Run all tests
bugster run
# Run tests in a specific directory
bugster run auth/
# Run with custom configuration
bugster run --headless --stream-results
# Run only tests affected by code changes
bugster run --only-affectedUpdate your test specs when your codebase changes. Intelligently detects modifications and updates relevant tests.
bugster update [options]
Options:
--update-only Only update existing specs
--suggest-only Only suggest new specs
--delete-only Only delete obsolete specs
--show-logs Show detailed logs during analysisSynchronize test cases with your team across different branches and environments.
bugster sync [options]
Options:
--branch BRANCH Branch to sync with (defaults to current)
--pull Only pull specs from remote
--push Only push specs to remote
--clean-remote Delete remote specs that don't exist locally
--dry-run Show what would happen without making changes
--prefer OPTION Prefer 'local' or 'remote' when resolving conflictsExamples:
# Sync with main branch
bugster sync --branch main
# Only download remote changes
bugster sync --pull
# Preview sync changes
bugster sync --dry-runGet debugging information about failed test runs from recent executions.
bugster issues [options]
Options:
--history Get issues from the last week
--save Save issues to .bugster/issues directoryUpdate Bugster CLI to the latest version.
bugster upgrade [options]
Options:
-y, --yes Automatically confirm the upgradeBugster CLI uses a YAML configuration file located at .bugster/config.yaml:
project_name: "My App"
project_id: "my-app-123456"
base_url: "http://localhost:3000"
credentials:
- id: "admin"
username: "admin"
password: "admin"
x-vercel-protection-bypass: "optional-bypass-key"Set up your API key to connect with the Bugster platform:
bugster authThis will guide you through:
- Opening the Bugster dashboard
- Copying your API key
- Configuring authentication locally
# 1. Set up your project
bugster init
# 2. Generate test cases from your codebase
bugster generate
# 3. Run all tests
bugster run
# 4. Run specific tests with streaming
bugster run auth/ --stream-results# Run tests in CI environment
bugster run \
--headless \
--stream-results \
--base-url $PREVIEW_URL \
--output results.json# Pull latest test changes from team
bugster sync --pull
# Update tests after code changes
bugster update
# Push updated tests to team
bugster sync --push# Run only tests affected by recent changes
bugster run --only-affected --max-concurrent 3
# Generate test cases with debugging
bugster generate --force --show-logs
# Sync with conflict resolution
bugster sync --prefer local --dry-runAfter initialization, Bugster creates the following structure:
.bugster/
├── config.yaml # Project configuration
├── tests/ # Generated test specifications
│ ├── auth/ # Feature-based test organization
│ │ ├── 1_login.yaml
│ │ └── 2_signup.yaml
│ └── dashboard/
│ └── 1_overview.yaml
├── results/ # Test execution results
├── videos/ # Test recordings (when enabled)
└── logs/ # Execution logs
- ✅ Next.js: Full support for both App Router and Pages Router
- 🚧 React: Coming soon
- 🚧 Vue.js: Coming soon
Bugster CLI applies intelligent test limits to ensure efficient execution:
- Free tier: Up to 5 tests per execution
- Distribution: Tests are distributed across feature folders
- Selection: Representative tests are chosen using smart algorithms
- Python: 3.10 or higher
- Node.js: 18 or higher
- Operating System: Windows 10+, macOS 10.15+, or Linux
- Browser: Chrome/Chromium (automatically installed via Playwright)
We welcome contributions! Please see our Contributing Guide for details.
This project is licensed under the MIT License - see the LICENSE file for details.
- 📚 Documentation: docs.bugster.dev
- 🌐 Dashboard: gui.bugster.dev
- 🐙 GitHub: github.com/Bugsterapp/bugster-cli
- 💬 Issues: GitHub Issues
Built with ❤️ by Bugster