Quick Reference

git clone https://github.com/TryCadence/Cadence.git
cd Cadence
make build              # macOS/Linux
.\scripts\build.ps1     # Windows

./bin/cadence version

go install github.com/TryCadence/Cadence/cmd/cadence@latest
cadence version

# Analyze current directory
cadence analyze . -o report.json

# Analyze local repo
cadence analyze /path/to/repo -o report.json

# Analyze GitHub repo (clones automatically)
cadence analyze https://github.com/owner/repo -o report.json

# Analyze specific branch
cadence analyze https://github.com/owner/repo --branch main -o report.json

# With custom thresholds (flags override config)
cadence analyze /repo --suspicious-additions 1000 -o report.json
cadence analyze /repo --max-additions-pm 150 -o report.json
cadence analyze /repo --min-time-delta 30 -o report.json

# Exclude files
cadence analyze /repo --exclude-files "*.lock,*.log" -o report.json

# With config file
cadence analyze /repo --config .cadence.yaml -o report.json

# Analyze website
cadence web https://example.com -o report.json

# Verbose output (detailed findings)
cadence web https://example.com --verbose -o report.json

# JSON format
cadence web https://example.com --json -o report.json

# Text format
cadence web https://example.com -o report.txt

# Print default config to stdout
cadence config

# Create config file in current directory
cadence config init
# Creates .cadence.yaml

# Use config file (always pass explicitly — auto-detection uses cadence.yml)
cadence analyze /repo --config .cadence.yaml -o report.json

# Start on default port (8000)
cadence webhook --secret "webhook-secret"

# Custom port and host
cadence webhook --port 8080 --host 0.0.0.0 --secret "webhook-secret"

# With config file
cadence webhook --config .cadence.yaml

# Custom workers and timeouts
cadence webhook --port 8080 --workers 8 --read-timeout 60 --write-timeout 60 --secret "secret"

cadence version

thresholds:
  suspicious_additions: 300
  suspicious_deletions: 500
  max_additions_per_min: 50
  max_files_per_commit: 20
  max_addition_ratio: 0.80
  enable_precision_analysis: true

thresholds:
  suspicious_additions: 500
  suspicious_deletions: 1000
  max_additions_per_min: 100
  max_files_per_commit: 50
  max_addition_ratio: 0.95
  min_deletion_ratio: 0.95
  min_commit_size_ratio: 100
  enable_precision_analysis: true

thresholds:
  suspicious_additions: 1000
  suspicious_deletions: 2000
  max_additions_per_min: 200
  max_files_per_commit: 100
  max_addition_ratio: 0.98

exclude_files:
  - package-lock.json    # Node.js lock file
  - yarn.lock           # Yarn lock file
  - Gemfile.lock        # Ruby lock file
  - "*.min.js"          # Minified files
  - dist/*              # Build output
  - build/*             # Build artifacts
  - ".next/*"           # Next.js output
  - node_modules/*      # Dependencies
  - "*.o"               # Compiled objects
  - "*.exe"             # Executables

cadence analyze /repo -o report.json   # JSON format
cadence analyze /repo -o report.txt    # Text format
cadence web https://example.com -o report.json  # JSON
cadence web https://example.com -o report.txt   # Text

CADENCE_AI_ENABLED=true               # Enable AI analysis
CADENCE_AI_KEY=sk-...                 # AI provider API key
CADENCE_AI_PROVIDER=openai            # "openai" or "anthropic"
CADENCE_AI_MODEL=gpt-4o-mini          # Model override (optional)
CADENCE_WEBHOOK_PORT=8080             # Webhook listen port
CADENCE_WEBHOOK_SECRET=secret         # Webhook HMAC secret

make build    # Build with version injection (output: ./bin/cadence)
make install  # Install to $GOPATH/bin
make test     # Run all tests
make fmt      # Format code
make lint     # Run linter (golangci-lint)
make tidy     # Run go mod tidy
make clean    # Clean artifacts
make help     # Show all targets

for repo in ~/projects/*; do
  cadence analyze "$repo" --config .cadence.yaml -o "reports/$(basename $repo).json"
done

cadence web https://example.com --verbose -o report.json
cat reports/report.json | grep -i suspicious

cadence analyze . --config .cadence.yaml -o report.json
if grep -q '"score": 0\.[89]' reports/report.json; then
  echo "Suspicious commits detected"
  exit 1
fi

cadence analyze https://github.com/owner/repo --branch feature -o feature.json
cadence analyze https://github.com/owner/repo --branch main -o main.json
diff reports/feature.json reports/main.json

cadence --help           # Show all commands
cadence analyze --help   # Help for analyze command
cadence web --help       # Help for web command
cadence config --help    # Help for config command
cadence webhook --help   # Help for webhook command

Cadence binary:           ./bin/cadence
Configuration file:       .cadence.yaml (in working directory)
Reports:                  ./reports/
Build scripts (Linux/Mac):  ./scripts/build.sh
Build script (Windows):     .\scripts\build.ps1