bugster init - Initialize Project Configuration

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:

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

Options

string

Bugster API key for authentication. Must start with ‘bugster_’. If not provided, will prompt for authentication.

string

Custom name for your project. Used for identification in the Bugster dashboard.

string

Base URL of your application where tests will be executed.

string

Username for login credentials used in automated tests.

string

Password for login credentials used in automated tests.

string

default:"admin"

Name for the credential entry in your configuration.

boolean

Skip credential setup entirely. You can configure credentials later.

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"

GETTING STARTED

GUIDES

USING THE CLI

HOSTING AND CI/CD

Init

Basic Usage

Command Overview

When to Use

Key Features

Command Syntax

Configuration Process

Options

Examples

Interactive Setup

Quick Setup with Parameters

Setup with Credentials

Skip Credential Configuration

Project Structure

Example Configuration

​Basic Usage

​Command Overview

​When to Use

​Key Features

​Command Syntax

​Configuration Process

​Options

​Examples

​Interactive Setup

​Quick Setup with Parameters

​Setup with Credentials

​Skip Credential Configuration

​Project Structure

​Example Configuration

Basic Usage

Command Overview

When to Use

Key Features

Command Syntax

Configuration Process

Options

Examples

Interactive Setup

Quick Setup with Parameters

Setup with Credentials

Skip Credential Configuration

Project Structure

Example Configuration