6.2 All command line options

This appendix lists all the command line options that are available when executing test cases with pybot or jybot, and when post-processing outputs with rebot.

6.2.1 Command line options for test execution

-N, --name <name>
Sets the name of the top-level test suite.
-D, --doc <document>
Sets the documentation of the top-level test suite.
-M, --metadata <name:value>
Sets free metadata for the top level test suite.
-G, --settag <tag>
Sets the tag(s) to all executed test cases.
-t, --test <name>
Selects the test cases by name.
-s, --suite <name>
Selects the test suites by name.
-R, --rerunfailed <file>
Selects failed tests from an earlier output file to be re-executed.
--runfailed <file>
Deprecated. Use --rerunfailed instead.
-i, --include <tag>
Selects the test cases by tag.
-e, --exclude <tag>
Selects the test cases by tag.
-c, --critical <tag>
Tests that have the given tag are considered critical.
-n, --noncritical <tag>
Tests that have the given tag are not critical.
-v, --variable <name:value>
Sets individual variables.
-V, --variablefile <path:args>
Sets variables using variable files.
-d, --outputdir <dir>
Defines where to create output files.
-o, --output <file>
Sets the path to the generated output file.
-l, --log <file>
Sets the path to the generated log file.
-r, --report <file>
Sets the path to the generated report file.
-x, --xunit <file>
Sets the path to the generated xUnit compatible result file.
--xunitfile <file>
Deprecated. Use --xunit instead.
--xunitskipnoncritical
Mark non-critical tests on xUnit compatible result file as skipped.
-b, --debugfile <file>
A debug file that is written during execution.
-T, --timestampoutputs
Adds a timestamp to all output files.
--splitlog Split log file into smaller pieces that open in browser transparently.
--logtitle <title>
Sets a title for the generated test log.
--reporttitle <title>
Sets a title for the generated test report.
--reportbackground <colors>
Sets background colors of the generated report.
-L, --loglevel <level>
Sets the threshold level for logging. Optionally the default visible log level can be given separated with a colon (:).
--suitestatlevel <level>
Defines how many levels to show in the Statistics by Suite table in outputs.
--tagstatinclude <tag>
Includes only these tags in the Statistics by Tag table.
--tagstatexclude <tag>
Excludes these tags from the Statistics by Tag table.
--tagstatcombine <tags:title>
Creates combined statistics based on tags.
--tagdoc <pattern:doc>
Adds documentation to the specified tags.
--tagstatlink <pattern:link:title>
Adds external links to the Statistics by Tag table.
--removekeywords <all passed name:pattern for wuks>
Removes keyword data from the generated log file.
--flattenkeywords <name:pattern>
Flattens keywords in the generated log file.
--listener <name:args>
Sets a listener for monitoring test execution.
--warnonskippedfiles
Show a warning when an invalid file is skipped.
--nostatusrc Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
--runemptysuite
Executes tests also if the selected test suites are empty.
--dryrun In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax.
--exitonfailure
Stops test execution if any critical test fails.
--exitonerror Stops test execution if any error occurs when parsing test data, importing libraries, and so on.
--skipteardownonexit
Skips teardowns is test execution is prematurely stopped.
--randomize <all suites tests none>
Randomizes test execution order.
--runmode <mode>
Deprecated in Robot Framework 2.8. Use separate --dryrun, --exitonfailure, --skipteardownonexit and --randomize options instead.
-W, --monitorwidth <chars>
Sets the width of the console output.
-C, --monitorcolors <on off force>
Specifies are colors used on the console.
-K, --monitormarkers <on off force>
Specifies are console markers (. and F) used.
-P, --pythonpath <path>
Additional locations where to search test libraries from when they are imported.
-E, --escape <what:with>
Escapes characters that are problematic in the console.
-A, --argumentfile <path>
A text file to read more arguments from.
-h, --help Prints usage instructions.
--version Prints the version information.

6.2.2 Command line options for post-processing outputs

-R, --merge Changes result combining behavior to merging.
--rerunmerge Deprecated. Use --merge instead.
-N, --name <name>
Sets the name of the top level test suite.
-D, --doc <document>
Sets the documentation of the top-level test suite.
-M, --metadata <name:value>
Sets free metadata for the top-level test suite.
-G, --settag <tag>
Sets the tag(s) to all processed test cases.
-t, --test <name>
Selects the test cases by name.
-s, --suite <name>
Selects the test suites by name.
-i, --include <tag>
Selects the test cases by tag.
-e, --exclude <tag>
Selects the test cases by tag.
-c, --critical <tag>
Tests that have the given tag are considered critical.
-n, --noncritical <tag>
Tests that have the given tag are not critical.
-d, --outputdir <dir>
Defines where to create output files.
-o, --output <file>
Sets the path to the generated output file.
-l, --log <file>
Sets the path to the generated log file.
-r, --report <file>
Sets the path to the generated report file.
-x, --xunit <file>
Sets the path to the generated xUnit compatible result file.
--xunitfile <file>
Deprecated. Use --xunit instead.
--xunitskipnoncritical
Mark non-critical tests on xUnit compatible result file as skipped.
-T, --timestampoutputs
Adds a timestamp to all output files.
--splitlog Split log file into smaller pieces that open in browser transparently.
--logtitle <title>
Sets a title for the generated test log.
--reporttitle <title>
Sets a title for the generated test report.
--reportbackground <colors>
Sets background colors of the generated report.
-L, --loglevel <level>
Sets the threshold level to select log messages. Optionally the default visible log level can be given separated with a colon (:).
--suitestatlevel <level>
Defines how many levels to show in the Statistics by Suite table in outputs.
--tagstatinclude <tag>
Includes only these tags in the Statistics by Tag table.
--tagstatexclude <tag>
Excludes these tags from the Statistics by Tag table.
--tagstatcombine <tags:title>
Creates combined statistics based on tags.
--tagdoc <pattern:doc>
Adds documentation to the specified tags.
--tagstatlink <pattern:link:title>
Adds external links to the Statistics by Tag table.
--removekeywords <all passed name:pattern for wuks>
Removes keyword data from the generated outputs.
--flattenkeywords <name:pattern>
Flattens keywords in the generated outputs.
--starttime <timestamp>
Sets the starting time of test execution when creating reports.
--endtime <timestamp>
Sets the ending time of test execution when creating reports.
--nostatusrc Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
--processemptysuite
Processes output files even if files contain empty test suites.
-E, --escape <what:with>
Escapes characters that are problematic in the console.
-A, --argumentfile <path>
A text file to read more arguments from.
-h, --help Prints usage instructions.
--version Prints the version information.

results matching ""

    No results matching ""