OS Manuals

/opt/chainguard/sqlfluff/bin/diff-quality

SQLFluff is a dialect-flexible, configurable SQL linter and auto-formatter ("The SQL Linter for Humans"). It parses SQL across many dialects, reports style/layout/convention rule violations, and can automatically fix or reformat files, with support for templated SQL (Jinja, placeholders, dbt via plugin) and multiple report formats.

From sqlfluff 4.5.0-r0 (enterprise-packages), captured 2026-11-08 by running diff-quality --help (exit 0). permalink

usage: diff-quality [-h] --violations TOOL [--format FORMAT] [--external-css-file FILENAME]
                    [--compare-branch BRANCH] [--options [OPTIONS]] [--fail-under SCORE]
                    [--minimum-change LINES] [--ignore-staged] [--ignore-unstaged]
                    [--include-untracked] [--exclude EXCLUDE [EXCLUDE ...]]
                    [--include INCLUDE [INCLUDE ...]] [--diff-range-notation RANGE_NOTATION]
                    [--version] [--ignore-whitespace] [-q] [-c CONFIG_FILE]
                    [--report-root-path ROOT_PATH] [--total-percent-float]
                    [input_reports ...]

Automatically find diff lines with quality violations.

positional arguments:
  input_reports         Which violations reports to use

options:
  -h, --help            show this help message and exit
  --violations TOOL     Which code quality tool to use (checkstyle/checkstylexml/clang/cppcheck/es
                        lint/findbugs/flake8/jshint/mypy/pmd/pycodestyle/pydocstyle/pyflakes/pylin
                        t/ruff.check/shellcheck)
  --format FORMAT       Format to use
  --external-css-file FILENAME
                        Write CSS into an external file
  --compare-branch BRANCH
                        Branch to compare
  --options [OPTIONS]   Options to be passed to the violations tool
  --fail-under SCORE    Returns an error code if coverage or quality score is below this value
  --minimum-change LINES
                        Always pass if total lines of change is below this value
  --ignore-staged       Ignores staged changes
  --ignore-unstaged     Ignores unstaged changes
  --include-untracked   Include untracked files
  --exclude EXCLUDE [EXCLUDE ...]
                        Exclude files, more patterns supported
  --include INCLUDE [INCLUDE ...]
                        Files to include (glob pattern)
  --diff-range-notation RANGE_NOTATION
                        Git diff range notation to use when comparing branches, defaults to '...'
  --version             show program's version number and exit
  --ignore-whitespace   When getting a diff ignore any and all whitespace
  -q, --quiet           Only print errors and failures
  -c, --config-file CONFIG_FILE
                        The configuration file to use
  --report-root-path ROOT_PATH
                        The root path used to generate a report
  --total-percent-float
                        Show total coverage/quality as a float rounded to 2 decimal places
Options (18)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--violations TOOLWhich code quality tool to use (checkstyle/checkstylexml/clang/cppcheck/es lint/findbugs/flake8/jshint/mypy/pmd/pycodestyle/pydocstyle/pyflakes/pylin t/ruff.check/shellcheck)help
--format FORMATFormat to usehelp
--external-css-file FILENAMEWrite CSS into an external filehelp
--compare-branch BRANCHBranch to comparehelp
--options OPTIONSOptions to be passed to the violations toolhelp
--fail-under SCOREReturns an error code if coverage or quality score is below this valuehelp
--minimum-change LINESAlways pass if total lines of change is below this valuehelp
--ignore-stagedIgnores staged changeshelp
--ignore-unstagedIgnores unstaged changeshelp
--include-untrackedInclude untracked fileshelp
--diff-range-notation RANGE_NOTATIONGit diff range notation to use when comparing branches, defaults to '...'help
--versionshow program's version number and exithelp
--ignore-whitespaceWhen getting a diff ignore any and all whitespacehelp
-q, --quietOnly print errors and failureshelp
-c, --config-file CONFIG_FILEThe configuration file to usehelp
--report-root-path ROOT_PATHThe root path used to generate a reporthelp
--total-percent-floatShow total coverage/quality as a float rounded to 2 decimal placeshelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.