SALT

Documentation
Source

Create an editable environment, lint one or more paths, and understand the exit status.

Install and run checks

Install from the checkout

python3 -m venv .venv
./.venv/bin/pip install -e .
./.venv/bin/pip install -e '.[dev]'

SALT requires Python 3.11 or newer. The dev extra adds the test dependencies.

Common invocations

salt check rtl tb
salt check . --config salt.yaml
salt check . --format json
salt check . --format html > salt-report.html
python -m salt check . --log-level info

Machine-readable output stays clean

Violations are written to stdout. Operational logging goes to stderr and is controlled by --log-level, so redirecting JSON or HTML does not mix diagnostics into the report.

Exit status

CodeMeaning
0 No violations were found.
1 At least one enabled rule reported a violation.