Skip to content

philterd/phinder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Phinder

A Java application that uses Phileas to identify PII (Personally Identifiable Information) in text across a wide variety of file formats. Types of PII are scored by magnitude, density, and confidence. A list of files suggested for redaction testing will be generated.

The goal of Phinder is to provide a comprehensive analysis of PII to help you take the next step to redact it with Philter. Note that Phinder may support more file types than Philter.

Visit http://philterd.github.io/phinder for documentation and more information.

Example Generated Report

Phinder

Quick Start

Build the project

mvn clean install

Run Phinder

java -jar target/phinder-1.0.0-SNAPSHOT.jar -i src/test/resources/input.txt

To process a directory recursively:

java -jar target/phinder-1.0.0-SNAPSHOT.jar -i src/test/resources/ -R

Note

Processing images requires tesseract-ocr to be installed.

At the completion of the scan, report.json and report.html files will be generated in the current directory.

Store report history in MongoDB

To store the report history in MongoDB, use the --mongodb CLI option:

java -jar target/phinder-1.0.0-SNAPSHOT.jar -i src/test/resources/input.txt --mongodb "mongodb://localhost:27017/phinder"

For more examples and detailed usage, please refer to the documentation.

License

Copyright 2026 Philterd, LLC.

This project is licensed under the Apache License 2.0.

About

Phinder is a command-line tool that scans many file types for personally identifiable information (PII) and generates a redaction-focused report.

Topics

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Contributors