Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quick Start

1. Set up credentials

Create ~/.bbscope.yaml with your platform credentials:

hackerone:
  username: "your_username"
  token: "your_api_token"

See Configuration for all platforms.

2. Print scopes (no database)

# All configured platforms
bbscope poll

# Just HackerOne, only bug bounty programs
bbscope poll h1 -b

# Custom output: target + description + program URL
bbscope poll -o tdu

3. Track changes with a database

Set up PostgreSQL and add the connection string to your config:

db:
  url: "postgres://user:pass@localhost:5432/bbscope?sslmode=disable"

Then poll with --db:

# First run populates the database silently
bbscope poll --db

# Subsequent runs print only changes (new/removed/updated targets)
bbscope poll --db

4. Query the database

# View stats
bbscope db stats

# Search for a target
bbscope db find "example.com"

# Extract wildcards for recon
bbscope db get wildcards

# Recent changes
bbscope db changes

5. Enable AI normalization (optional)

Add an OpenAI API key to your config:

ai:
  api_key: "sk-..."
bbscope poll --db --ai

This cleans up messy scope entries (e.g., "*.example.com (main site)" becomes *.example.com) and caches results in the database to avoid redundant API calls.