Usage

Environment

.NET

.NET Core

.NET Framework

The full .NET framework

Azure DevOps

Github Action

NuGet Package

ReportGenerator

Use this package if your project is based on .NET Framework or .NET and you want to use ReportGenerator via the command line or a build script.

dotnet-reportgenerator-globaltool

Use this package if your project is based on .NET and you want to use ReportGenerator as a (global) 'DotnetTool'.

Reports

Path to the coverage report(s) that should be parsed.
Globbing is supported.

Add report

Target directory

The directory where the generated report(s) should be saved.

Report types

Download sample reports

Filter:

Html

The default output format. Creates a summary overview (index.html) and detailed reports for each class.
Sample report

Html_Light

Same as Html but with a light theme.
Sample report

Html_Dark

Same as Html but with a dark theme.
Sample report

Html_BlueRed

Same as Html but with the colors blue/red instead of green/red.
Sample report

HtmlSummary

Creates a single HTML file (summary.html) without links.
Sample report

Html_BlueRed_Summary

Same as HtmlSummary but with the colors blue/red instead of green/red.
Sample report

HtmlChart

Creates a single HTML file containing a chart with historic coverage information.
Sample report

HtmlInline

Same as HTML but CSS and JavaScript is included in every HTML page. This results in larger file sizes, but can be useful for integration into build servers like Azure DevOps (VSTS), since they may block referenced CSS and JavaScript files.
Sample report

HtmlInline_AzurePipelines

Same as HtmlInline but with an adaptive light/dark theme matching the look and feel of Azure Pipelines
Sample report

HtmlInline_AzurePipelines_Light

Same as HtmlInline but with a light theme matching the look and feel of Azure Pipelines.
Sample report

HtmlInline_AzurePipelines_Dark

Same as HtmlInline but with a dark theme matching the look and feel of Azure Pipelines.
Sample report

MHtml

Same as HTML but packaged into a single MHTML file.
Sample report

Clover

Creates a XML file in Clover format. This format integrates with tools like Atlassian Bamboo.
Sample report

Cobertura

Creates a XML file in Cobertura format. This format integrates with tools like Azure DevOps (VSTS) or Jenkins.
Sample report

OpenCover

Creates a XML file in OpenCover format (PRO version only).
Sample report

SonarQube

Creates a XML file in SonarQube 'Generic Test Data' format.
Sample report

lcov

Creates a text file in 'lcov' format.
Sample report

XML

Creates a XML file containing a summary for all classes and detailed reports for each class.
Sample report

XMLSummary

Creates a single XML file containing a summary for all classes.
Sample report

JsonSummary

Creates a single JSON file containing a summary for all classes.
Sample report

CodeClimate

Creates a single JSON file containing a (Gitlab) code climate report.
Sample report

Latex

Creates a single TEX file containing a summary for all classes and detailed reports for each class.
Sample report

LatexSummary

Creates a single TEX file containing a summary for all classes.
Sample report

TeamCitySummary

Command line output interpreted by TeamCity.

TextSummary

Creates a single TXT file containing coverage information per class.
Sample report

TextDeltaSummary

Creates a single TXT file containing delta coverage information.
Sample report

CsvSummary

Creates a single CSV file containing coverage information per class.
Sample report

MarkdownSummary

Creates a single Markdown file containing coverage information per class.
Sample report

MarkdownAssembliesSummary

Creates a single Markdown file containing coverage information per assembly.
Sample report

MarkdownSummaryGithub

Creates a single Markdown file containing coverage information per class. The report is optimized for GitHub.
Sample report

MarkdownDeltaSummary

Creates a single Markdown file containing delta coverage information.
Sample report

SvgChart

Creates a single SVG file containing a chart with historic coverage information.
Sample report

Badges

Creates SVG files that show line and/or branch coverage information.
Sample report

Source directories

Optional directories which contain the corresponding source code.
The source directories are used if coverage report contains classes without path information.

Add source directory

History directory

Optional directory for storing persistent coverage information. Choose a directory which does not get deleted between builds.
Required to show the history chart in the HTML reports.

Plugins

Optional plugin files for custom reports or custom history storage.

Add plugin

Assembly filters

Optional list of assemblies that should be included or excluded in the report.
Exclusion filters take precedence over inclusion filters.
Wildcards are allowed.