Options
Every command-line flag, its default, and its key in .poly-crap.toml.
Every flag has a key in .poly-crap.toml
unless noted. The command line wins over the file, and the file over the
defaults, except that exclude and allow lists are joined and a boolean is
on when either side sets it.
Scope
--path <DIR>, default.. The directory to scan and the root that relative paths, globs, and auto-discovery use. Command line only.--language <NAME>, keylanguages. Repeatable; the file takes a list. Scans all six languages by default.--exclude <GLOB>, keyexclude. Repeatable; see Excluded paths.--no-default-excludes. Drops the built-in exclude list. Command line only; the file usesdefault-excludes = [...]to replace the list instead.--allow <GLOB>, keyallow. Repeatable; see Allow lists.--diff-base <REV>. Scores only functions changed since the merge base withREV. Command line only.
Coverage
--coverage <FILE>, keycoverage. Repeatable; reports are merged. Paths in the file are relative to the working directory.--no-auto-coverage. Skips the default-location search when no report is named. Command line only.--missing <POLICY>, keymissing, defaultpessimistic. Alsooptimisticorskip.
Gates
--threshold <SCORE>, keythreshold, default5. The score a function must stay at or under. Also decides which rows the table and SARIF show.--fail-above, keyfail-above. Exit1when any function is over the threshold.--baseline <FILE>. A JSON report from an earlier run to compare against. Command line only.--fail-regression, keyfail-regression. Exit1when any score rose from the baseline. Requires--baseline.--epsilon <DELTA>, keyepsilon, default0.01. A score change within this much counts as unchanged.
Output
--format <FORMAT>, keyformat, defaulthuman. Alsojsonorsarif.--output <FILE>. Write the report to a file instead of stdout. Command line only.--color <WHEN>, defaultauto. Alsoalwaysornever. Command line only; see Color.--min <SCORE>, keymin. Show rows scoring at least this much. Human output otherwise shows rows over the threshold; JSON shows every row.--top <N>, keytop. Show at mostNrows, highest scores first.--sort <ORDER>, keysort, defaultcrap. Alsofile.--summary, keysummary. Human output without the table.
--min, --top, --sort, and --summary change what is printed, never
the gates or the summary counts.
Performance
--jobs <N>, keyjobs. Threads for parsing. Defaults to the number of cores.