Skip to main content

Quick Start

Short task-oriented paths to first success. Not sure where to start? Pick your goal in the cookbook. Installation details: Installation. CLI flag list: CLI reference.

Scan a CSV in 30 seconds​

pip install metacrafter
printf 'email,name\nalice@example.com,Alice Example\nbob@example.com,Bob Example\n' > people.csv
metacrafter scan file people.csv --format short

Write machine-readable JSON:

metacrafter scan file people.csv \
  --format full \
  --output-format json \
  --stdout \
  --pretty

Detect PII in a file​

metacrafter scan file users.csv \
  --contexts pii \
  --langs en \
  --confidence 20.0 \
  --format full \
  -o pii_scan.json

Scan a SQLite database​

metacrafter scan sql "sqlite:///users.db" \
  --contexts pii \
  --format full \
  --output-format json \
  -o sqlite_results.json

Inspect loaded rules​

metacrafter rules list
metacrafter rules stats

Next steps​