Bug Bounty Guide

Bug Bounty Guide is the purpose-built, local-first workspace for security researchers to organize reconnaissance data, track target scopes, and document vulnerability findings seamlessly.

---

📸 Screenshot Placeholder

✨ Key Features

• Security-Native Workspace: Understands scopes, domains, and IPs natively.
• Local-First Privacy: All your engagement data stays on your machine.
• Fast Recon Search: Blazing fast search tailored for large recon datasets.
• Markdown Focused: Security-flavored markdown for seamless note-taking.

📚 Documentation Index

• Beta Testing Guide
• Public Beta Announcement
• Beta Changelog
• Security Policy

🚀 Getting Started

Install and Run

1. Download the latest release for your OS from the Releases page.
2. Extract the archive.
3. Run the executable.

Build from Source

python -m pip install -r requirements.txt
python build_scripts/build.py

Run from Source

python main.py

Lint

pip install ruff
ruff check app/ main.py build_scripts/ scripts/

🛡️ Support and Security

• Support: Open an issue on GitHub. Please check our Support Guide before filing an issue.
• Security: If you find a security vulnerability within this application, please review our Security Policy and report it securely.