コンテンツにスキップ

クイックスタート

解析を実行する

uvx pyscn@latest analyze .

pyscn がすでにインストールされている場合(uv tool install pyscnpipx install pyscnpip install pyscn のいずれか)、uvx pyscn@latest プレフィックスは不要です:

pyscn analyze .

HTML レポートが .pyscn/reports/analyze_YYYYMMDD_HHMMSS.html に出力され、デフォルトブラウザで自動的に開かれます。

出力フォーマットの選択

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

特定の解析だけを実行する

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

すべてのフラグについては analyze を参照してください。

CI 品質ゲート

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

詳しくは checkCI/CD Integration をご覧ください。

設定ファイルの生成

pyscn init

すべてのオプションがコメント付きで記載された .pyscn.toml を生成します。詳しくは Configuration Reference をご覧ください。