Documentation
A small set of guides to embedding Cribra and understanding its contracts.
Start with a guide
Getting started Add Cribra to a Rust application, scan caller-owned text, and choose an integration. Core concepts Understand caller-owned data, deterministic detection, and the difference between findings and review candidates. Explicit transformations Create transformed derivatives with redaction, templates, keyed pseudonymization, synthesis, and Share Bundles. Scanning modes Choose whole-source scanning, admitted append-only byte streams, or revisioned incremental documents.
Browse by topic
- Getting started
- Core concepts
- Detection and validation
- Reporting and review
- Transformations
- Streaming
- Incremental scanning
- Interoperability
Go deeper
These guides introduce the contracts. The repository documentation retains detailed design and qualification evidence; Rust API documentation describes public types and methods.
Check compatibility and distribution before choosing an adapter, or explore runnable examples.