CLI Commands
Initialize project
Set up Bugster CLI in your project and authenticate with your account
Overview
Purpose: Sets up Bugster configuration in your repository for the first time. When to use:- Once per repository - typically done by one team member
- When starting a new project with Bugster
- If you need to reconfigure project settings
- Creates
.bugster/directory with project configuration - Must be committed to git for CI/CD integration
- Requires API key (will prompt for authentication if needed)
- Safe to re-run (will ask before overwriting existing config)
CLI Reference
| Command | Description | Example |
|---|---|---|
bugster init | Initialize with interactive prompts | bugster init |
bugster init --api-key <key> | Initialize with specific API key | bugster init --api-key bugster_abc123... |
bugster init --project-name <name> | Set custom project name | bugster init --project-name "My App" |
bugster init --url <url> | Set application URL | bugster init --url http://localhost:3000 |
bugster init --user <username> --password <pwd> | Configure login credentials | bugster init --user admin --password secret |
bugster init --no-credentials | Skip credential setup entirely | bugster init --no-credentials |
Flags
| Flag | Description | Example |
|---|---|---|
--api-key | Bugster API key (starts with ‘bugster_‘) | --api-key bugster_org_abc... |
--project-name | Name for your project | --project-name "E-commerce App" |
--url | Base URL of your application | --url https://staging.myapp.com |
--user | Username for login credentials | --user testuser@example.com |
--password | Password for login credentials | --password mypassword123 |
--credential-name | Name for credential entry (default: admin) | --credential-name staging |
--no-credentials | Skip credential setup entirely | --no-credentials |
--bypass-protection | Protection bypass secret for deployment platforms | --bypass-protection abc123... |