About PerformanceTestRunner

Applies to ReadyAPI 3.53, last modified on June 07, 2024

PerformanceTestRunner runs load tests and exports results as configured. You use it to run ReadyAPI load tests from the command line.

You can start the runner from the command line or from the ReadyAPI user interface. The latter approach is useful, when you need to build the command line and check the settings. See below.

Tip: Besides automating runs of load tests, you can also automate runs of functional and security tests.


The runner is located in the <ReadyAPI>/bin directory. The file name is loadtestrunner.bat (Windows) or loadtestrunner.sh (Linux and macOS).


The load test runner is installed along with ReadyAPI and uses the same modules. It does not require any special license as it uses the existing ReadyAPI Performance license you have.

Test runner specifics

ReadyAPI checks the folder specified in the Script Library folder every 5 seconds. If you set the script library folder dynamically, you need to wait for it to be loaded to use it. To do this, add a delay to your script after you command it to load the script library:

project.scriptLibrary = project.getPropertyValue("dataPath")

If you run a test on a headless machine, add the -Djava.awt.headless=true JVM option. It prevents the test runner from interacting with UI elements. To learn how to set the option, see Modifying JVM Settings.

Get the generated command line

Via the Get Command Line option

Specify the needed parameters in the dialog and click Get Command Line.

The Get Command Line button

Click the image to enlarge it.

ReadyAPI will generate the command line and show it in a separate dialog.

The dialog with the command line

Click the image to enlarge it.

To copy the text to the clipboard, you can select it with the mouse and click Copy to Clipboard.

Via the runner launch

  • After you specified the desired launch parameters in the dialog, click Launch to start the runner:

    LoadUI TestRunner Dialog

    You will see the test log:

    Test log window
  • After the run finishes, you can find the generated command line at the beginning of the test log:

    The command line in the test log

    Select text in the window and copy it to the clipboard.

See Also

Command-Line Arguments

Highlight search results