Reports

An HTML report is always generated by Phinder (defaulting to report.html). You can also optionally generate reports in other formats.

Report Formats

Format	Option	Description
HTML	html	A modern, visually attractive HTML report (always generated).
Text	text	A human-readable text file.
PDF	pdf	A structured PDF document.
JSON	json	A machine-readable JSON file.

Generating a Report

Phinder always generates an HTML report at report.html. If you provide a custom path using -r or --report and specify the format as html (or use a .html extension), that path will be used for the HTML report.

To generate an additional report in another format, use the -f or --format option.

Examples

Default (Generates report.html):

java -jar phinder.jar -i input.txt

Generates report.html AND a custom PDF Report:

java -jar phinder.jar -i documents/ -r results.pdf -f pdf

Generates report.html AND a JSON Report:

java -jar phinder.jar -i documents/ -r results.json -f json

Generates a single HTML Report at a custom path:

java -jar phinder.jar -i documents/ -r results.html -f html

Report Content

Every report includes: 1. Aggregate Magnitude Score: Total magnitude across all files. 2. Aggregate Density Score: Magnitude score divided by total word count across all files. 3. Aggregate PII Counts: Total number of occurrences for each PII type. 4. Files Skipped: The number of files skipped because they hadn't changed since the last scan. 5. PII Weights: The weights used for each PII type (if custom weights were provided). 6. Best Candidates for Redaction Testing: A table of the top 20 files with the most PII variety and highest scores (HTML format only). 7. Per-file Details: For each file, the Magnitude and Density Scores, and the counts of each PII type found.