CLI Reference

Scan Command

Basic syntax:

clausi scan PATH [options]

Default: Without --claude or --openai flags, scans use Clausi AI (no API key needed). Pricing: $2.00 minimum + $0.80/100k tokens.

Scan Options

FlagDescription
-r, --regulationRegulation key (repeat for multiple)
--claude [MODEL]BYOK: Use your Anthropic API key ($0.50/scan)
--openai [MODEL]BYOK: Use your OpenAI API key ($0.50/scan)
--presetUse clause preset (critical-only, high-priority) - saves 60-80% cost
--open-findingsAuto-open findings.md in your default editor
--templateReport template (default, detailed, executive)
-o, --outputOutput directory (otherwise uses config)
--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-cache-statsDisplay cache statistics (shows cost savings)

Examples

EU AI Act Scan (Clausi AI - Default)

clausi scan . -r EU-AIA

Uses Clausi AI, no API key needed

Scan with Claude (BYOK)

clausi scan . -r EU-AIA --claude

Uses your Anthropic API key, $0.50 flat rate per scan

Multiple Regulations

clausi scan ~/project -r EU-AIA -r GDPR -r SOC2

Cost-Saving Preset

clausi scan . -r EU-AIA --preset critical-only --open-findings

Scans only critical clauses (saves 60-80% cost)

Output Files

Upon completion the CLI stores reports in your project's clausi/ folder:

  • findings.md – Main compliance findings report
  • traceability_matrix.md – Code-to-clause mapping
  • compliance_report.pdf – Executive PDF report
  • metadata.json – Scan session metadata

Configuration

Settings are stored in a YAML file:

Windows: %USERPROFILE%\.clausi\config.yml
macOS/Linux: ~/.clausi/config.yml

Example configuration:

# API keys (optional - for BYOK mode)
api_keys:
  anthropic: "sk-ant-..."  # For --claude flag
  openai: "sk-..."         # For --openai flag

report:
  company_name: "ACME Corp"
  company_logo: "C:/assets/logo.png"
  template: "default"      # default | detailed | executive

regulations:
  default: EU-AIA          # default regulation for scans

Config Commands

CommandPurpose
clausi config showDisplay current configuration
clausi config set [...]Update configuration values
clausi config editOpen config in your editor
clausi config pathPrint config file location

Environment Variables

VariablePurpose
ANTHROPIC_API_KEYAPI key for Claude (Anthropic) - for BYOK mode
OPENAI_API_KEYAPI key for OpenAI - for BYOK mode
CLAUSI_OUTPUT_DIROverrides output directory

Precedence: CLI flag → environment variable → config file → default

Tip: Using BYOK Mode

Set your API key as an environment variable for BYOK mode ($0.50/scan):

export ANTHROPIC_API_KEY=sk-ant-your-key-here

Get your key from: console.anthropic.com