UNPKG

yahdlp

Version:

Enterprise-grade PII detection and redaction tool by Yahya Enterprises

57 lines (47 loc) 1.52 kB
# PII Detection and Redaction Examples ## Overview This document demonstrates the usage of PII (Personally Identifiable Information) detection and redaction tools through practical examples. ## Phone Number Inspection ### Command ```bash ./index.js inspect -t "+41313131313" -p ``` ### Response ```json [ { "type": "PHONE", "value": "+41313131313", "normalized": "41313131313" } ] ``` ### Example Explanation In this example: - The `inspect` command analyzes a phone number - The `-t` flag specifies the target text - The `-p` flag indicates phone number detection - The response includes the detected phone number with its normalized format ## Image Redaction Attempt ### Command ```bash ./index.js redact yahAPPROACH.png output.png -p ``` ### Response ```plaintext (node:9300) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead. (Use `node --trace-deprecation ...` to show where the warning was created) No matching PII found ``` ### Example Explanation In this example: - The `redact` command attempts to process an image - Input image: `yahAPPROACH.png` - Output destination: `output.png` - The `-p` flag enables phone number detection - No PII was found in the image - A deprecation warning was generated for the `punycode` module ## Notes - Commands should be run from the project root directory - The tool supports both text and image-based PII detection - Deprecation warnings can be safely ignored for current functionality