Quick Start

Run an analysis

uvx pyscn@latest analyze .

If pyscn is already installed (via uv tool install pyscn, pipx install pyscn, or pip install pyscn), drop the uvx pyscn@latest prefix:

pyscn analyze .

Writes an HTML report to .pyscn/reports/analyze_YYYYMMDD_HHMMSS.html and opens it in the default browser.

Select output format

pyscn analyze --json .
pyscn analyze --yaml .
pyscn analyze --csv .
pyscn analyze --no-open .       # suppress browser open

Run specific analyzers

pyscn analyze --select complexity .
pyscn analyze --select complexity,deadcode .
pyscn analyze --skip-clones .

See analyze for all flags.

CI quality gate

pyscn check .                              # exit 0 pass, 1 fail
pyscn check --max-complexity 15 src/
pyscn check --select complexity,deadcode,deps src/

See check and CI/CD Integration.

Generate a config file

pyscn init

Creates .pyscn.toml with every option commented. See the Configuration Reference.