gcovr
generate GCC code coverage reports
website and documentation • bugtracker • GitHub
Gcovr provides a utility for managing the use of the GNU gcov utility and generating summarized code coverage results. This command is inspired by the Python coverage.py package, which provides a similar utility for Python.
The gcovr command can produce different kinds of coverage reports:
CLI Option |
User Guide |
Description |
|---|---|---|
default, --txt |
compact human-readable summaries |
|
--html |
overview of all files |
|
--html-details |
annotated source files |
|
--html-template-dir |
use custom set of Jinja2 templates |
|
--csv |
CSV report summarizing the coverage of each file |
|
--json |
JSON report with source file structure and coverage |
|
--json-summary |
JSON summary coverage report |
|
--markdown |
Markdown coverage report |
|
--markdown-summary |
Markdown summary coverage report |
|
--clover |
machine readable XML reports in Clover format |
|
--cobertura |
machine readable XML reports in Cobertura format |
|
--coveralls |
machine readable JSON report in Coveralls format |
|
--jacoco |
machine readable XML reports in JaCoCo format |
|
--lcov |
machine readable report in LCOV info format |
|
--sonarqube |
machine readable XML reports in SonarQube format |
Thus, gcovr can be viewed as a command-line alternative to the lcov utility, which runs gcov and generates an HTML-formatted report. The development of gcovr was motivated by the need for text summaries and XML reports.
Example HTML summary:
Example HTML details:
Installation
Gcovr is available as a Python package that can be installed via pip.
Install newest stable gcovr release from PyPI:
pip install gcovrInstall development version from GitHub (needs at least version 21.3 of pip):
pip install git+https://github.com/gcovr/gcovr.gitQuickstart
GCC can instrument the executables to emit coverage data. You need to recompile your code with the following flags:
--coverage -g -O0
Next, run your test suite. This will generate raw coverage files.
Finally, invoke gcovr. This will print a tabular report on the console.
gcovr
You can also generate detailed or nested HTML reports:
gcovr --html-details coverage.html gcovr --html-nested coverage.html
Gcovr will create one HTML report per source file and for --html-nested also per directory next to the coverage.html summary.
You should run gcovr from the build directory. The -r option should point to the root of your project. This only matters if you have a separate build directory. For example:
cd build; gcovr -r ..
For complete documentation, read the manual.
Contributing
If you want to report a bug or contribute to gcovr development, please read our contributing guidelines first: https://gcovr.com/en/latest/contributing.html
License
This software is distributed under the 3-clause BSD License. See https://gcovr.com/en/latest/license.html#license-terms for details. See https://gcovr.com/en/latest/license.html#acknowledgements for the full list of contributors.
Release files for gcovr 8.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gcovr-8.7.tar.gz | 807.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gcovr-8.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / gcovr-8.7.tar.gz
| Download URL | gcovr-8.7.tar.gz |
|---|---|
| Size | 807.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cfb9b2c373cc5be4b1cbe53250a5e4446fe6d4723c6900d3f41aa83540c8ddc8
|
|
BLAKE2b-256 checksum How to use checksums |
0947c19e5c16988ef485210825101e78ab9ea05b08c2361aa4e51b40d6c484ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency logRelease files / gcovr-8.7-py3-none-any.whl
| Download URL | gcovr-8.7-py3-none-any.whl |
|---|---|
| Size | 862.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2a68612c5981c388537f2e236c231a5d788b8bd9e406d13ced662c97b17e9784
|
|
BLAKE2b-256 checksum How to use checksums |
a04d10b517f35dda7c3cbf30dcadd0461522299ccc1cb648944e2ffea7147c58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency log
