Kover Command Line Interface
This single jar artifact allows using some of the functionality of Kover Toolset through command-line calls.
Java 1.6 or higher is required for execution.
Commands
Offline instrumentation
For information about offline instrumentation, see.
java -jar kover-cli.jar instrument [<class-file-path> ...] --dest <dir> [--exclude <class-name>] [--excludeAnnotation <annotation-name>] [--hits] [--include <class-name>]
Option | Description | Required | Multiple |
---|---|---|---|
<class-file-path> |
list of the compiled class-files roots | + | + |
–dest |
path to write instrumented Java classes to | + | |
–exclude |
filter to exclude classes from instrumentation, wildcards * and ? are acceptable. Excludes have priority over includes |
+ | |
–excludeAnnotation |
filter to exclude annotated classes from instrumentation, wildcards * and ? are acceptable |
+ | |
–hits | a flag to enable line hits counting | ||
–include |
instrument only specified classes, wildcards * and ? are acceptable |
+ |
Generating reports
Allows you to generate HTML and XML reports from the existing binary report.
java -jar kover-cli.jar report [<binary-report-path> ...] --classfiles <class-file-path> [--exclude <class-name>] [--excludeAnnotation <annotation-name>] [--html <html-dir>] [--include <class-name>] --src <sources-path> [--title <html-title>] [--xml <xml-file-path>]
Option | Description | Required | Multiple |
---|---|---|---|
<binary-report-path> |
list of binary reports files | + | |
–classfiles |
location of the compiled class-files root (must be original and not instrumented) | + | + |
–exclude |
filter to exclude classes, wildcards * and ? are acceptable |
+ | |
–include |
filter to include classes, wildcards * and ? are acceptable |
+ | |
–excludeAnnotation |
filter to exclude classes and functions marked by this annotation, wildcards * and ? are acceptable. Excludes have priority over includes |
+ | |
–includeAnnotation |
filter to include classes marked by this annotation, wildcards * and ? are acceptable |
+ | |
–excludeInheritedFrom |
filter to exclude classes extending the specified class or implementing an interface, wildcards * and ? are acceptable |
+ | |
–includeInheritedFrom |
filter to include only classes extending the specified class or implementing an interface, wildcards * and ? are acceptable |
+ | |
–html |
generate a HTML report in the specified path | ||
–src |
location of the source files root | + | + |
–title |
title in the HTML report | ||
–xml |
generate a XML report in the specified path |