dotCover Help

Console Runner Commands

dotCover Console Runner provides the following commands:

  • analyse - All-in-one task. Performs coverage analysis, generates report and removes snapshots.
  • cover - Perform coverage analysis of the specified application.
  • delete - Delete all files related to the specified snapshots.
  • help - Show console runner help.
  • list - Obtain list of all files related to the specified snapshots.
  • merge - Merge several coverage snapshots.
  • report - Create a report by the specified snapshot.
  • version - Write dotCover version info to the specified file.
  • zip - Compress coverage snapshot.

You can learn everything about each command right in the console by typing help followed by the command name. All commands (including help) have corresponding shortcuts. For instance, to get information about the analyse command, we can type:

dotCover.exe help analyse
or
dotCover h a

analyse

analyse: All-in-one task. Performs coverage analysis, generates report and removes snapshots. usage: dotCover analyse [parameters] Valid parameters: /TargetExecutable=ARG : (Required) File name of the program to analyse /TargetArguments=ARG : (Optional) Program arguments /TargetWorkingDir=ARG : (Optional) Program working directory /TempDir=ARG : (Optional) Directory for auxiliary files. Set to the system temp by default /ReportType=ARG : (Optional) [HTML|JSON|XML|DetailedXML|NDependXML]. A type of the report. XML by default /Output=ARG : (Required) Resulting report file name /InheritConsole=ARG : (Optional) [True|False] Lets the application being analysed to inherit dotCover console. True by default Please note that windows of analysed GUI application will not be hidden if the console is inherited /AnalyseTargetArguments=ARG : (Optional) [True|False] Specifies whether dotCover should analyse target arguments string and convert relative paths to absolute there. True by default /Scope : (Optional) Allows Including not loaded assemblies in the specified scope into coverage results. The parameter is a semicolon separated list of file path masks. Ant-style patterns are supported here (e.g. ProjectFolder/**/*.dll) /Filters=ARG : (Optional) Specifies coverage filters using the following syntax: +:module=*;class=*;function=*; Use -:myassembly to exclude an assembly from code coverage. Asterisk wildcard (*) is supported here /AttributeFilters=ARG : (Optional) Specifies attribute filters using the following syntax: filter1;filter2;... Asterisk wildcard (*) is supported here /DisableDefaultFilters : (Optional) Disables default (automatically added) filters /SymbolSearchPaths=ARG : (Optional) Specifies additional symbol search paths. Paths to symbol servers (starting with srv* prefix) are supported here. Values are separated with semicolon /AllowSymbolServerAccess : (Optional) Allows dotCover to search for PDB files on a symbol server /ReturnTargetExitCode : (Optional) Returns the exit code of the target executable in case coverage analysis succeeded Global parameters: /LogFile=ARG : (Optional) Enables logging and specifies log file name It is possible to specify part of the parameters or all of them in the configuration file. usage: dotCover analyse <configuration file name> [parameters] Configuration file format: <AnalyseParams> <TargetExecutable><!-- File name of the program to analyse. --></TargetExecutable> <TargetArguments><!-- Program arguments. --></TargetArguments> <TargetWorkingDir><!-- Program working directory. --></TargetWorkingDir> <TempDir><!-- Directory for the auxiliary files. Set to system temp by default. --></TempDir> <Output><!-- Resulting report file name. --></Output> <ReportType><!-- [HTML|JSON|XML|NDependXML]. A type of the report. XML by default. --></ReportType> <InheritConsole><!-- [True|False] Lets the application being analysed to inherit dotCover console. True by default. --></InheritConsole> <AnalyseTargetArguments><!-- [True|False] Specifies whether dotCover should analyse target arguments string and convert relative paths to absolute there. True by default. --><AnalyseTargetArguments> <!-- Appends coverage results with assemblies in specified scope that were not loaded during analysis. Ant-style patterns are supported here. <Scope> <ScopeEntry>ProjectFolder/**/*.dll</ScopeEntry> <ScopeEntry>ProjectFolder/**/*.exe</ScopeEntry> </Scope> --> <!-- Coverage filters. It's possible to use asterisks as wildcard symbols. <Filters> <IncludeFilters> <FilterEntry> <ModuleMask> Module mask </ModuleMask> <ClassMask> Class mask </ClassMask> <FunctionMask> Function mask </FunctionMask> </FilterEntry> </IncludeFilters> <ExcludeFilters> <FilterEntry>...</FilterEntry> <FilterEntry>...</FilterEntry> <FilterEntry>...</FilterEntry> </ExcludeFilters> </Filters> --> <!-- Attribute filters. It's possible to use asterisks as wildcard symbols. <AttributeFilters> <AttributeFilterEntry> Attribute class mask </AttributeFilterEntry> <AttributeFilterEntry>System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute</AttributeFilterEntry> </AttributeFilters> --> </AnalyseParams>

cover

cover: Performs coverage analysis of the specified application. usage: dotCover cover [parameters] Valid parameters: /TargetExecutable=ARG : (Required) File name of the program to analyse /TargetArguments=ARG : (Optional) Program arguments /TargetWorkingDir=ARG : (Optional) Program working directory /TempDir=ARG : (Optional) Directory for auxiliary files. Set to the system temp by default /Output=ARG : (Required) Path to the resulting coverage snapshot /InheritConsole=ARG : (Optional) [True|False] Lets the application being analysed to inherit dotCover console. True by default Please note that windows of analysed GUI application will not be hidden if the console is inherited /AnalyseTargetArguments=ARG : (Optional) [True|False] Specifies whether dotCover should analyse target arguments string and convert relative paths to absolute there. True by default /Scope : (Optional) Allows Including not loaded assemblies in the specified scope into coverage results. The parameter is a semicolon separated list of file path masks. Ant-style patterns are supported here (e.g. ProjectFolder/**/*.dll) /Filters=ARG : (Optional) Specifies coverage filters using the following syntax: +:module=*;type=*;function=*; Use -:myassembly to exclude an assembly from code coverage. Asterisk wildcard (*) is supported here /AttributeFilters=ARG : (Optional) Specifies attribute filters using the following syntax: filter1;filter2;... Asterisk wildcard (*) is supported here /DisableDefaultFilters : (Optional) Disables default (automatically added) filters /SymbolSearchPaths=ARG : (Optional) Specifies additional symbol search paths. Paths to symbol servers (starting with srv* prefix) are supported here. Values are separated with semicolon /AllowSymbolServerAccess : (Optional) Allows dotCover to search for PDB files on a symbol server /ReturnTargetExitCode : (Optional) Returns the exit code of the target executable in case coverage analysis succeeded Global parameters: /LogFile=ARG : (Optional) Enables logging and specifies log file name It is possible to specify part of the parameters or all of them in the configuration file. usage: dotCover cover <configuration file name> [parameters] Configuration file format: <CoverageParams> <TargetExecutable><!-- File name of the program to analyse. --></TargetExecutable> <TargetArguments><!-- Program arguments. --></TargetArguments> <TargetWorkingDir><!-- Program working directory. --></TargetWorkingDir> <TempDir><!-- Directory for the auxiliary files. Set to system temp by default. --></TempDir> <Output><!-- Path to the resulting coverage snapshot. --></Output> <InheritConsole><!-- [True|False] Lets the application being analysed to inherit dotCover console. True by default. --></InheritConsole> <AnalyseTargetArguments><!-- [True|False] Specifies whether dotCover should analyse target arguments string and convert relative paths to absolute there. True by default. --><AnalyseTargetArguments> <!-- Appends coverage results with assemblies in specified scope that were not loaded during analysis. Ant-style patterns are supported here. <Scope> <ScopeEntry>ProjectFolder/**/*.dll</ScopeEntry> <ScopeEntry>ProjectFolder/**/*.exe</ScopeEntry> </Scope> --> <!-- Coverage filters. It's possible to use asterisks as wildcard symbols. <Filters> <IncludeFilters> <FilterEntry> <ModuleMask> Module mask </ModuleMask> <ClassMask> Class mask </ClassMask> <FunctionMask> Function mask </FunctionMask> </FilterEntry> </IncludeFilters> <ExcludeFilters> <FilterEntry>...</FilterEntry> <FilterEntry>...</FilterEntry> <FilterEntry>...</FilterEntry> </ExcludeFilters> </Filters> --> <!-- Attribute filters. It's possible to use asterisks as wildcard symbols. <AttributeFilters> <AttributeFilterEntry> Attribute class mask </AttributeFilterEntry> <AttributeFilterEntry>System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute</AttributeFilterEntry> </AttributeFilters> --> </CoverageParams>

delete

delete: Delete all files related to the specified snapshots. usage: dotCover delete <configuration file> Valid options: /Source=ARG : List of snapshot files separated with semicolon (;) Global options: /LogFile=ARG : Enables logging and specifies log file name Configuration file format: <DeleteParams> <!-- At least one source required. --> <Source><!-- Source file 1 --></Source> <Source><!-- Source file 2 --></Source> <Source><!-- Source file N --></Source> </DeleteParams>

help

help: Show console runner help. Type 'dotCover help <command>' for help on a specific command, parameters and configuration xml format Type 'dotCover help <command> <file name>' to write configuration xml example to the specified file

list

list: Obtain list of all files related to the specified snapshots. usage: dotCover list [parameters] Valid parameters: /Source=ARG : (Required) List of snapshot files separated with semicolon (;) /Output=ARG : (Required) Resulting file name. Stores plain list of all snapshot files. Global parameters: /LogFile=ARG : (Optional) Enables logging and specifies log file name It is possible to specify part of the parameters or all of them in the configuration file. usage: dotCover list <configuration file name> [parameters] Configuration file format: <ListParams> <!-- At least one source required. --> <Source><!-- Source file 1 --></Source> <Source><!-- Source file 2 --></Source> <Source><!-- Source file N --></Source> <Output><!-- Resulting file name. Stores plain list of all snapshot files. --></Output> </ListParams>

merge

merge: Merge several coverage snapshots. usage: dotCover merge [parameters] Valid parameters: /Source=ARG : (Required) List of snapshots separated with semicolon (;) /Output=ARG : (Required) File name for the merged snapshot /TempDir=ARG : (Optional) Directory for the auxiliary files. Set to system temp by default Global parameters: /LogFile=ARG : (Optional) Enables logging and specifies log file name It is possible to specify part of the parameters or all of them in the configuration file. usage: dotCover merge <configuration file name> [parameters] Configuration file format: <MergeParams> <!-- At least one source required. --> <Source><!-- Source file 1 --></Source> <Source><!-- Source file 2 --></Source> <Source><!-- Source file N --></Source> <TempDir><!-- Directory for the auxiliary files. Set to system temp by default. --></TempDir> <Output><!-- File name for the merged snapshot. --></Output> </MergeParams>

report

report: Create a report by the specified snapshot. usage: dotCover report [parameters] Valid parameters: /Source=ARG : (Required) Coverage snapshot file name /Output=ARG : (Required) Resulting report file name /ReportType=ARG : (Optional) [HTML|JSON|XML|NDependXML]. A type of the report. XML by default Global parameters: /LogFile=ARG : (Optional) Enables logging and specifies log file name It is possible to specify part of the parameters or all of them in the configuration file. usage: dotCover report <configuration file name> [parameters] Configuration file format: <ReportParams> <Source><!-- Coverage snapshot file name. --></Source> <Output><!-- Resulting report file name. --></Output> <ReportType><!-- [HTML|JSON|XML|NDependXML]. A type of the report. XML by default. --></ReportType> </ReportParams>

version

version: Write dotCover version info to the specified file. usage: dotCover version <output file name> Global options: /LogFile=ARG : Enables logging and specifies log file name

zip

zip: Compress coverage snapshot. usage: dotCover zip <configuration file> Valid options: /Source=ARG : Coverage snapshot file name /Output=ARG : Zipped snapshot file name Global options: /LogFile=ARG : Enables logging and specifies log file name <ZipParams> <Source><!-- Required. Coverage snapshot file name. --></Source> <Output><!-- Required. Zipped snapshot file name. --></Output> </ZipParams>

See Also

Last modified: 13 August 2015