Automation Reference

User rating:
3.4 (7 ratings)

The content on this page is related to a deprecated version of LoadUI, which has been superseded by LoadUI NG Pro in the Ready! API platform. Click here to learn more.

Command line runner usage

There are several command line switches you can use to control the behavior of the command. They are as follows:

-a, --agents
Setting this switch, once or more, allows you to specify which agents to run the test on. Multiple agents may be specified, and each agent may specify which Scenarios it should be assigned to. The syntax for doing this is:

-a <ip>[:<port>][=<scenario>[,<scenario>] ...]

With default values:
For instance:


would run the test with two agents, all Scenarios assigned to the agent, and Scenarios MyScenario and MyOtherScenario would run on When specifying agents on the command line, any agents assigned to the Scenarios in the Project file will be disregarded.
-A, --abort
Overrides "Abort ongoing requests on finish" project property. If set to true ongoing requests will be canceled, if false test will finish when all ongoing requests complete. If not set, property value from project will be used to determine what to do with ongoing requests.
-c, --compare <arg>
Specify a saved execution to use as a base for comparison in the generated statistics report.
-D <arg>
Sets system property with name=value.
-e, --export <arg>
Export raw data from all charts to target folder,
( usage -e <file>=<chart>[,<file>=<chart>] ... )
-f, --file <arg>
Executes the specified Groovy script file.
-F, --format
Sets the output format for the generated reports. Supported formats are: PDF, XLS, HTML, RTF, CSV, TXT and XML. This parameter is not case sensitive. In case -r (--reports) parameter is not specified, this parameter is ignored.
-h, --help
Displays a short summary of the available command line switches.
-l, --local
Sets the run mode to local mode, meaning no agents will be used, and Scenarios will be executed by the local computer. The command line runner always defaults to distributed mode.
-L, --limits <arg>
Sets the limits (::) for the execution (e.g. -L 60:0:200 )
Do not include or require the JavaFX runtime.
-L, --limits
Allows you to override the saved limits for the test with your own. The syntax is:

-L ::

For instance:

-L 60:0:5

would run the test for 60 seconds, or until 5 failures have occurred. Setting a limit to 0 means no limit.
Disable the lock file that prevents several copies of LoadUI to run at the same time.
-p, --project
Specifies the path to the Project file to run.
-r, --reports
Sets the directory where the generated Summary Report will be stored. If specified directory does not exist it will be created automatically. If specified path represents the path to an existing file than reports will be saved in the parent folder of that file. If not specified, reports won't be generated at all.
-s, --summary
Set to include summary report in statistics report.
-S, --statistics
Sets which Statistics pages to add to the generated report (leave blank save all pages).
-t, --testcase
Specifies which TestCase in the project to execute. If omitted, the entire Project is executed. Deprecated since LoadUI 2.0.
Specifies which Virtual User Scenario in the project to execute. If omitted, the entire Project is executed.
-w, --workspace
Specifies which Workspace file to use when executing. The Workspace holds global settings. If omitted, the default Workspace is used.
Use the saved zoom levels for charts from the project.

Note: If you have a space in your path or a Scenario name, you will have to wrap the argument in quotation (") marks.

Note: Blank spaces in names have to be escaped with "\". For example, if you name the file Chart 1, use -e /stash/export.csv=Chart\ 1