diff-cover - Man Page

manual page for diff-cover 5.0.0


usage: diff-cover [-h]

[--html-report FILENAME | --json-report FILENAME | --markdown-report FILENAME] [--external-css-file FILENAME] [--compare-branch BRANCH] [--fail-under SCORE] [--ignore-staged] [--ignore-unstaged] [--exclude EXCLUDE [EXCLUDE ...]] [--src-roots DIRECTORY [DIRECTORY ...]] [--diff-range-notation RANGE_NOTATION] [--version] [--ignore-whitespace] coverage_xml [coverage_xml ...]

Automatically find diff lines that need test coverage.

positional arguments


XML coverage report

optional arguments

-h, ā€‰--help

show this help message and exit

--html-report FILENAME

Diff coverage HTML output

--json-report FILENAME

Diff coverage JSON output

--markdown-report FILENAME

Diff coverage Markdown output

--external-css-file FILENAME

Write CSS into an external file

--compare-branch BRANCH

Branch to compare

--fail-under SCORE

Returns an error code if coverage or quality score is below this value


Ignores staged changes


Ignores unstaged changes

--exclude EXCLUDE [EXCLUDE ...]

Exclude files, more patterns supported

--src-roots DIRECTORY [DIRECTORY ...]

List of source directories (only for jacoco coverage reports)

--diff-range-notation RANGE_NOTATION

Git diff range notation to use when comparing branches, defaults to '...'


show program's version number and exit


When getting a diff ignore any and all whitespace


March 2021 diff-cover 5.0.0