Skip to content

TheGr8Val/TGV-ReportForge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TGV-ReportForge

TGV-ReportForge

Professional security reports, forged in the terminal.
Reportes de seguridad profesionales, forjados en la terminal.

 ____                        _   _____
|  _ \ ___ _ __   ___  _ __| |_|  ___|__  _ __ __ _  ___
| |_) / _ \ '_ \ / _ \| '__| __| |_ / _ \| '__/ _` |/ _ \
|  _ <  __/ |_) | (_) | |  | |_|  _| (_) | | | (_| |  __/
|_| \_\___| .__/ \___/|_|   \__|_|  \___/|_|  \__, |\___|
          |_|                                  |___/

  Professional security reports, forged in the terminal  |  thegr8val

✨ Features

Feature Detail
🌐 Bilingual Full EN / ES UI at runtime
📋 5 report types Bug Bounty · Threat Hunt · IR · Vuln Assessment · Exec Summary
🧙 Interactive wizard Step-by-step guided input with live progress bar
👁️ Live preview Rich-formatted terminal preview before every export
📤 4 export formats Markdown · HTML (dark theme) · PDF · JSON
🛡️ MITRE ATT&CK Built-in selector — 30 most common techniques
🔍 CWE Top 25 Autocomplete for CWE IDs
🏷️ Auto-naming [type]-[title-slug]-[timestamp].[ext]
🔒 100% offline No API calls, no telemetry
⚙️ Pipeline-ready JSON export for CI/CD and SIEM ingestion

🔄 How It Works

  python main.py
       │
       ▼
  ┌─────────────┐     ┌──────────────────┐     ┌────────────────────┐
  │  🎨 Banner  │────▶│  🌐 Language     │────▶│  📋 Report Type    │
  │   Screen    │     │  EN / ES         │     │  Select (1 of 5)   │
  └─────────────┘     └──────────────────┘     └────────────────────┘
                                                         │
       ┌─────────────────────────────────────────────────┘
       ▼
  ┌────────────────────┐     ┌──────────────────┐     ┌─────────────┐
  │  🧙 Wizard         │────▶│  👁️ Live Preview │────▶│  📤 Export  │
  │  Step-by-step      │     │  Rich panels     │     │  MD/HTML/   │
  │  + progress bar    │     │  + confirm       │     │  PDF/JSON   │
  └────────────────────┘     └──────────────────┘     └─────────────┘
                                                              │
                                                              ▼
                                                       reports/
                                                       [type]-[slug]-[ts].[ext]

📋 Report Types

Report Type Wizard Sections Severity MITRE
🐛 Bug Bounty Target · Vuln · Repro · Impact · Researcher
🎯 Threat Hunt Scope · Techniques · Findings · Risk · Exec Summary
🚨 Incident Response Timeline · Containment · Eradication · Recovery
🔬 Vulnerability Assessment Scope · Methodology · Findings · Risk
📊 Executive Summary Context · Key Findings · Risk · Strategy

🎨 Severity Color System

  ██  Critical      CVSS 9.0 – 10.0   bold red
  ██  High          CVSS 7.0 – 8.9    red
  ██  Medium        CVSS 4.0 – 6.9    yellow
  ██  Low           CVSS 0.1 – 3.9    cyan
  ██  Informational CVSS 0.0          dim white

Consistent across terminal UI, HTML export, and PDF output.


📤 Export Formats

  ┌──────────┬────────────────────────────────────────────────────────┐
  │ Format   │ Description                                            │
  ├──────────┼────────────────────────────────────────────────────────┤
  │ .md      │ Clean Markdown — paste into GitHub, Notion, HackMD    │
  │ .html    │ Styled dark theme — share or print from browser        │
  │ .pdf     │ WeasyPrint → ReportLab fallback — client-ready         │
  │ .json    │ Machine-readable — SIEM ingestion, pipeline use        │
  └──────────┴────────────────────────────────────────────────────────┘

⚡ Quick Start

git clone https://github.com/TheGr8Val/TGV-ReportForge.git
cd TGV-ReportForge
pip install -r requirements.txt
python main.py

For best PDF quality: pip install weasyprint


🗂️ Project Structure

TGV-ReportForge/
├── 🚀 main.py                        ← entry point
├── 📦 requirements.txt
├── forge/
│   ├── 🎨 banner.py                  ← ASCII art + welcome/goodbye screens
│   ├── 🧙 wizard.py                  ← 5 interactive report wizards
│   ├── 🗂️  templates.py               ← MITRE ATT&CK, CWE Top 25, static data
│   ├── 🔨 builder.py                 ← Jinja2 template renderer
│   ├── 📤 exporter.py                ← MD / HTML / PDF / JSON export engine
│   └── 👁️  visualizer.py              ← Rich preview + results table
├── templates/                        ← Jinja2 report templates
│   ├── bug_bounty.j2
│   ├── blue_team_hunt.j2
│   ├── incident_response.j2
│   ├── vulnerability_assessment.j2
│   └── executive_summary.j2
└── reports/                          ← generated reports saved here

⚙️ Pipeline Integration

# Run and select JSON export
python main.py

# Output: reports/bug_bounty-my-finding-20240415-143022.json
import json

report = json.load(open("reports/bug_bounty-my-finding-20240415-143022.json"))
print(report["severity"])    # "High"
print(report["cvss_score"])  # "7.8"
# Feed into SIEM, ticketing system, or automation pipeline

🤝 Contributing

See CONTRIBUTING.md.


📄 License

MIT — thegr8val


TGV Toolkit





Made with ⚒️ by thegr8val

About

Automated cybersecurity report generation — turn structured findings into polished reports

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages