Skip to content

Getting started

Requirements

  • Python 3.12+
  • Razin installed in your environment (pip install razin)

Install

From PyPI:

pip install razin

From Homebrew core:

brew install razin

If the formula is not yet in core, use the tap:

brew tap theinfosecguy/homebrew-tap
brew install razin

Verify install:

razin --help

First scan

razin scan -r . -o output/

This writes per-skill artifacts under output/<skill-name>/.

Common scan modes

# Strict policy profile
razin scan -r . -o output/ --profile strict

# Show only summary in stdout (CI-friendly logs)
razin scan -r . -o output/ --summary-only

# Show only medium/high findings
razin scan -r . -o output/ --min-severity medium

# Show only security-classified findings
razin scan -r . -o output/ --security-only

# Combine filters
razin scan -r . -o output/ --security-only --min-severity medium

CI gating examples

# Fail if any high-severity finding exists
razin scan -r . --fail-on high --no-stdout

# Fail if aggregate score is 70+
razin scan -r . --fail-on-score 70 --no-stdout

# Use summary-only output with fail gate
razin scan -r . --summary-only --fail-on medium

Validate config before scanning

razin validate-config -r .

Output formats

# JSON (default)
razin scan -r . -o output/ --output-format json

# CSV + SARIF + JSON in one run
razin scan -r . -o output/ --output-format json,csv,sarif

Next docs to read