π₯· Byakugan
The hackerβs all-seeing eye β a dark-themed, AI-powered recon tool
---
## π What is Byakugan?
**Byakugan** is a dark-themed, AI-augmented recon framework for ethical hackers and bug bounty hunters.
It automates:
- π Subdomain enumeration
- π Live host discovery
- πΈ Screenshot capture
- π§ AI-driven risk summaries, exploit suggestions, and bounty tagging
Inspired by the legendary *dojutsu*, Byakugan gives hackers **clairvoyant recon power**.
---
## βοΈ Features
- π Subdomain enum via `subfinder`, `amass`, `crt.sh`, and more
- β οΈ Live probing with `httpx`
- π· Screenshots with `gowitness`
- π€ AI analysis using **Gemini API**, optional fallback to GPT
- π Organized outputs: `subdomains.txt`, `live.txt`, `screenshots/`, `analysis.json`
- π Continues from previous scans β smart caching
- π» CLI-first, optional FastAPI + Tailwind web dashboard
- π§ͺ Designed for real bug bounty workflows
---
## π¦ Install
```bash
# Clone the repo
git clone https://github.com/lavsarkari/byakugan
cd byakugan
# Create and activate virtual environment
python3 -m venv Byakugan
source Byakugan/bin/activate
# Install dependencies
pip install -r requirements.txt
```
---
## π Usage
```bash
python byakugan.py -d example.com
```
Options coming soon:
```bash
--resume Continue if scan already exists
--no-ai Skip AI analysis
--dashboard Launch web UI (WIP)
```
---
## π API Keys
Create `secrets.py` like this:
```python
OPENAI_API_KEY = "sk-..."
GEMINI_API_KEY = "AIzaSy..."
```
---
## π Output Structure
```
output/
βββ example.com/
βββ subdomains.txt
βββ live.txt
βββ screenshots/
βββ analysis.json
```
---
## π Example Output
> βScanning `nmap.com` with Byakuganβ¦β
```shell
Found 8 subdomains
Found 8 live hosts
Captured 8 screenshots
π AI Analysis:
- 2 High-Risk Targets
- 3 Potential for Bounties
```
---
## π§ Powered By
* [subfinder](https://github.com/projectdiscovery/subfinder)
* [httpx](https://github.com/projectdiscovery/httpx)
* [gowitness](https://github.com/sensepost/gowitness)
* [Gemini API](https://ai.google.dev)
* [OpenAI GPT-3.5](https://platform.openai.com)
---
## π‘οΈ Disclaimer
For educational and authorized testing purposes only. You are responsible for your actions.