Search full documentation and examples →
← Cribra

Examples

Runnable repository examples, synthetic inputs, and explicit integration boundaries.

Rust scanning

scan_basic.rs builds custom rules, scans an ordered batch, and inspects finding metadata. Run cargo run --example scan_basic.

query_results.rs demonstrates finding queries and aggregate results. The quick start includes a short scanning excerpt.

Redaction and transformation

financial_review.rs composes current and opt-in financial catalogs, reviews synthetic PAN/IBAN findings, and creates a redacted derivative. Run cargo run --example financial_review.

share_safe.rs builds a redacted Share Bundle. Transformations act on findings; candidates and undetected values may remain. Read the transformation guide.

CLI

From the repository root, build the existing binary and scan a checked-in synthetic fixture:

Terminal window
cargo build -p cribra-cli
target/debug/cribra scan examples/fixtures/inputs/credentials.env --format json

The CLI accepts an explicit UTF-8 file or stdin and performs no directory traversal. Exit code 0 includes finding-bearing scans. See the CLI contract; registry installation is not assumed.

WebAssembly

The browser example scans and redacts caller-owned text locally. The runtime example loads the same production artifact in Node.js, Bun, or Deno.

Terminal window
just wasm-production
node examples/wasm-runtime/scan.mjs

These repository commands require the documented Rust WASM target, matching wasm-bindgen CLI, and Binaryen. The website does not bundle a scanner or build Rust/WASM. Follow each example's prerequisites and compare source and distribution coverage.

Built with Cribra

A future collection of applications and integration stories, added when their availability and use of Cribra can be verified.