Skip to main content
The bugster init command guides you through setting up a new Bugster project. It creates configuration files, helps you configure your application, and sets up test credentials for automated testing.

​
Basic Usage

bugster init

​
Command Overview

Sets up Bugster configuration in your repository for the first time, creating the necessary project structure and configuration files.

​
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

​
Key Features

  • Interactive project setup
  • Creates .bugster/ directory with project configuration
  • Configures application URL and credentials
  • Safe to re-run (will ask before overwriting existing config)
The configuration must be committed to git for CI/CD integration and requires an API key for authentication.

​
Command Syntax

bugster init [options]

​
Configuration Process

When you run bugster init, the following steps occur:
  1. Authentication Check: Verifies you’re authenticated with the Bugster API (run bugster auth first if not)
  2. Project Setup: Creates .bugster/ directory and configuration files
  3. Application Configuration: Collects your application URL and settings
  4. Credential Setup: Configures login credentials for testing
  5. Verification: Tests the configuration to ensure it works

​
Options

​
--api-key
string
Bugster API key for authentication. Must start with ‘bugster_’. If not provided, will prompt for authentication.
​
--project-name
string
Custom name for your project. Used for identification in the Bugster dashboard.
​
--url
string
Base URL of your application where tests will be executed.
​
--user
string
Username for login credentials used in automated tests.
​
--password
string
Password for login credentials used in automated tests.
​
--credential-name
string
default:"admin"
Name for the credential entry in your configuration.
​
--no-credentials
boolean
Skip credential setup entirely. You can configure credentials later.
​
--bypass-protection
string
Protection bypass secret for deployment platforms like Vercel or Netlify.

​
Examples

​
Interactive Setup

bugster init
Guides you through the complete setup process with interactive prompts.

​
Quick Setup with Parameters

bugster init --project-name "My E-commerce App" --url http://localhost:3000

​
Setup with Credentials

bugster init --user admin@example.com --password secret123 --credential-name staging

​
Skip Credential Configuration

bugster init --no-credentials
Sets up the project without configuring any login credentials.

​
Project Structure

After running the command, the following structure is created: 
.bugster/
├── config.yaml          # Main project configuration
└── credentials/          # Encrypted credential storage
    └── admin.yaml       # Default credential file
Always commit the .bugster/ directory to version control. The configuration is required for CI/CD integration and team collaboration.

​
Example Configuration

After initialization, your config.yaml might look like: 
project_id: "proj_abc123"
project_name: "My E-commerce App"
base_url: "https://staging.myapp.com"
default_credentials: "admin"
⌘I