CLI Options

Phinder is a command-line application. Below is a list of all available options.

Option	Long Option	Description
-i	--input	Required. The input file(s) or directories to scan. Repeat for multiple.
-R	--recursive	Recursively traverse subdirectories if directories are provided.
-p	--policy	Path to a custom Phileas policy (JSON file).
	--emit-policy	Write a starter redaction policy covering the entity types found, to the given file. Emits PhiSQL for a .phisql file, otherwise JSON.
-w	--weights	Path to custom PII weights (JSON file) used for the Magnitude Score.
	--severities	Path to custom PII risk severities (JSON file) used for the Risk Score.
	--sort-by	Order the per-file report sections by risk, magnitude, density, or name. (Default: risk)
	--min-risk	Omit files scoring below this Risk Score from the per-file report sections. Aggregate totals still cover the whole scan. (Default: 0)
	--top	How many files to list as candidates for redaction testing. (Default: 20)
-l	--log	Enable the scan log using a MongoDB database.
-s	--skip-unchanged	Skip scanning files that haven't changed since the last scan log.
	--clean	Truncate the scan log database.
	--mongodb	The MongoDB URI for the scan log and report history.
	--csv-delimiter	Custom CSV delimiter character. (Default: ,)
	--csv-quote	Custom CSV quote character. (Default: ")
-h	--help	Show the help message and exit.
-V	--version	Show the application version and exit.

Examples

Scan multiple files

java -jar phinder.jar -i file1.txt -i file2.docx

Scan a directory recursively with custom weights

java -jar phinder.jar -i my_docs/ -R -w weights.json

Prioritize the riskiest files

java -jar phinder.jar -i my_docs/ -R --sort-by risk --min-risk 50 --top 10

Scan with custom risk severities

java -jar phinder.jar -i my_docs/ -R --severities my-severities.json

Generate a starter redaction policy from a scan

java -jar phinder.jar -i my_docs/ -R --emit-policy starter-policy.json

To get the policy as PhiSQL instead, use a .phisql extension:

java -jar phinder.jar -i my_docs/ -R --emit-policy starter-policy.phisql