Markdown Report

HoundDog.ai's code scanner is able to generate Markdown reports for point-in-time views of the sensitive data elements in your codebase, along with their sensitivity levels, occurrence counts, file locations and code snippets.

Here is an example command that scans directory ~/foo and generates a markdown file at ~/foo/report.md:

hounddog scan ~/foo --output-format=markdown --output-filename=report.md

Viewing the Report

We recommend using Google Chrome and the Markdown Viewer browser extension to view the reports. Enable the extension's mermaid and toc options to ensure all content renders correctly:

File access must also be granted to the extension:

Sensitive Datamap

The Sensitive Datamap section of the Markdown report displays the sensitive data elements detected in the scanned repository, including their sensitivity levels (low, medium, critical), occurrence counts, file paths, line numbers and code snippets.

Vulnerabilities

The Vulnerabilities section of the Markdown report is available only in the Starter and Enterprise plans (see pricing and API Keys for more details). It displays the sensitive dataflows detected in the scanned repository.

Dataflow Visualizations

The Dataflow Visualizations section of the markdown report is available only in the Starter and Enterprise plans. (see pricing and API Keys for more details). It displays the sensitive dataflows in the scanned repository in a graphical format using Mermaid.js.