Documentation

The full documentation lives in docs/:

Page	What it covers
Getting Started	Installation, the Monolog tap, redact(), inspect(), the fluent builder, profiles and the five that ship.
Configuration	Every key in config/redactor.php with its type, default and environment variable; the shipped profiles compared.
Rules	Pattern rules, validators, keywords, samples, dictionary rules, allow-lists, path rules, safe and blocked keys, known secrets, confidence and how detections are resolved.
Operators and Pseudonymisation	Every operator with example output, precedence, surrogates, the key and salt, reversible tokens and detokenize().
Boundaries	Log channels, HTTP responses, streams, MCP servers, AI agents, exports and jobs, and the RedactionPerformed event.
Scanning	redactor:scan in full: paths, output formats, git modes, decoding, baselines, suppression, verification, the hook and workflow, exit codes.
Entity Recognition	Finding names, places and organisations in prose with a Presidio-compatible recogniser or the in-process redactor-onnx package, and when not to.
Testing	Redactor::fake() and its assertions, redactor:validate, rule samples, the package's own test conventions.
Extending	Every contract, how to register each, a worked custom strategy and operator, and macros.
Upgrading	Every renamed class and method from 0.1.0, every behaviour change, and what to do about each.