Commands

Scanning Projects

Basic syntax:

clausi scan PATH [options]

Common Options

FlagDescription
-r, --regulationRegulation key (repeat for multiple)
--mode ai | fullai = lightweight analysis (default), full = deep scan
--format pdf | html | json | allReport format (use 'all' for PDF, HTML, and JSON)
--templateReport template (default, detailed, executive)
-o, --outputOutput directory (otherwise uses config)
--presetNEW v1.0.0: Use clause preset (critical-only, high-priority) - saves 60-80% cost
--ai-providerNEW v1.0.0: Choose AI provider (claude, openai)
--ai-modelNEW v1.0.0: Specify AI model (e.g., claude-3-5-sonnet-20241022)
--open-findingsNEW v1.0.0: Auto-open findings.md in your default editor
--show-markdownNEW v1.0.0: Show markdown preview in terminal
--show-cache-statsNEW v1.0.0: Display cache statistics (shows cost savings)
--max-costMaximum cost in dollars (e.g., --max-cost 1.00)
--skip-confirmationSkip the confirmation prompt
--min-severityMinimum severity to report (info, warning, high, critical)
--ignoreIgnore files/directories (can be given multiple times)
--show-detailsShow per-file token estimates

Examples

EU AI Act – Fast Scan

clausi scan . -r EU-AIA --mode ai

GDPR Deep Scan, HTML Report

clausi scan /srv/app -r GDPR --mode full --format html

Scan Against Both Regulations, Use Detailed Template

clausi scan ~/project -r EU-AIA -r GDPR --template detailed

Output Files (v1.0.0)

Upon completion the CLI prints a table of findings and stores:

  • findings.md (NEW) – Main compliance findings report (auto-opens in your editor)
  • traceability.md (NEW) – Code-to-clause mapping showing which files satisfy which clauses
  • action_plan.md (NEW) – Step-by-step remediation plan with priorities
  • compliance_report.pdf – Executive PDF report
  • audit_metadata.json – Summary of the scan session

Tip: Use --open-findings to automatically open findings.md in your editor after the scan completes.