Skip to main content

CLI tool to convert DAST JSON reports into readable Markdown summaries.

Project description

VulnDigest - DAST JSON to Markdown Report Generator

VulnDigest is a fast, cross-platform CLI tool that converts Dynamic Application Security Testing (DAST) JSON reports into clean, readable Markdown summaries grouped by severity.


Features

  • Converts DAST JSON reports into structured Markdown
  • Summary-only mode for fast triage
  • Works with ZAP, Burp, and other compatible scanners
  • Available via pip, apt, winget, prebuilt binary, or git clone

Installation Options

Option 1: Install via pip (Python 3.8+)

pip install vulndigest

Option 2: Install via apt (Linux)

sudo apt-get update
sudo apt-get install vulndigest

(Coming soon: hosted APT repository or PPA)

Option 3: Install via winget (Windows 10+)

winget install vulndigest

Option 4: Download a Prebuilt Binary

  • Go to GitHub Releases
  • Download the appropriate binary for your system:
    • vulndigest.exe for Windows
    • vulndigest for Linux/macOS

Option 5: Clone and run from source

git clone https://github.com/yourname/vulndigest.git
cd vulndigest
pip install -r requirements.txt
python vulndigest_cli.py -i example_dast.json -o report.md

Usage

Generate Markdown Report

vulndigest -i report.json -o output.md

Print Summary Only

vulndigest -i report.json --summary

File Structure


vulndigest/
├── vulndigest/                # Python package
│   ├── __init__.py
│   ├── __main__.py            # Entry point
│   └── vulndigest_cli.py      # Core CLI logic
├── example_dast.json          # Sample input report
├── LICENSE                    # MIT license
├── README.md                  # You're reading it
├── requirements.txt           # Python dependencies
└── pyproject.toml             # Packaging metadata


Example Output

## High Findings (1)

### VULN-001
- Severity: High
- Description: SQL Injection in login form.
- Location: /login
- Identifiers:
| Name | Value |
|------|-------|
| CWE  | 89    |

Roadmap Ideas

  • Merge multiple JSON reports
  • PDF export

Copyright (c) 2025 Tyler Walker

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vulndigest-1.0.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vulndigest-1.0.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file vulndigest-1.0.0.tar.gz.

File metadata

  • Download URL: vulndigest-1.0.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for vulndigest-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4210553270829907e15f385df73f4bf462631411dfe8e8dbcf4356b9090ba745
MD5 cd58e1eecc241bd06d1a2f1dcdc21488
BLAKE2b-256 d4d1a48d596e39352468b2072ec048189b04184bbeaff20d0de3cdd41d525ae8

See more details on using hashes here.

File details

Details for the file vulndigest-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: vulndigest-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for vulndigest-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4c6180eae7e7bf29ace9171d8c6b995c182448077a87c66d6ad0a012ca58483
MD5 bc01530a423b4f559caa5023ab8d0638
BLAKE2b-256 bdff9595a38b0f49614a7e2a7525206910cc2b9cb3a93b4953f4a981c0a075f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page