Commands
Scanning Projects
Basic syntax:
clausi scan PATH [options]Default: Without --claude or --openai flags, scans use Clausi AI (no API key needed). Pricing: $3.00 base + $0.40/100k LOC (up to 200k LOC).
Common Options
| Flag | Description |
|---|---|
-r, --regulation | Regulation key (repeat for multiple) |
--mode ai | full | ai = lightweight analysis (default), full = deep scan |
--format pdf | html | json | all | Report format (use 'all' for PDF, HTML, and JSON) |
--template | Report template (default, detailed, executive) |
-o, --output | Output directory (otherwise uses config) |
--preset | NEW v1.0.0: Use clause preset (critical-only, high-priority) - saves 60-80% cost |
--claude [MODEL] | BYOK: Use your Anthropic API key ($0.50/scan). Optional model: claude-3-5-sonnet-20241022 |
--openai [MODEL] | BYOK: Use your OpenAI API key ($0.50/scan). Optional model: gpt-4o |
--open-findings | NEW v1.0.0: Auto-open findings.md in your default editor |
--show-markdown | NEW v1.0.0: Show markdown preview in terminal |
--show-cache-stats | NEW v1.0.0: Display cache statistics (shows cost savings) |
--max-cost | Maximum cost in dollars (e.g., --max-cost 1.00) |
--skip-confirmation | Skip the confirmation prompt |
--min-severity | Minimum severity to report (info, warning, high, critical) |
--ignore | Ignore files/directories (can be given multiple times) |
--show-details | Show per-file token estimates |
Examples
EU AI Act Scan (Clausi AI - Default)
clausi scan . -r EU-AIAUses Clausi AI, no API key needed
Scan with Claude (BYOK)
clausi scan . -r EU-AIA --claudeUses your Anthropic API key, $0.50 flat rate per scan
Scan with OpenAI (BYOK)
clausi scan . -r EU-AIA --openai gpt-4oUses your OpenAI API key with specified model
Multiple Regulations with Detailed Template
clausi scan ~/project -r EU-AIA -r GDPR --template detailedCost-Saving Preset Scan
clausi scan . -r EU-AIA --preset critical-only --open-findingsScans only critical clauses (saves 60-80% cost) and opens findings in editor
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 clausesaction_plan.md(NEW) – Step-by-step remediation plan with prioritiescompliance_report.pdf– Executive PDF reportaudit_metadata.json– Summary of the scan session
Tip: Use --open-findings to automatically open findings.md in your editor after the scan completes.