Install Runtime Engine

Estimated reading time: 2 minutes

Starting from version 7.0.0, you need a Runtime Engine (RE) license to activate and run Katalon Studio or Katalon Studio Enterprise from the command line.

Download RE

  1. Log in to your Katalon account on the Katalon website.

  2. Select the compatible version of Runtime Engine with your operating system and download. For example, Linux version:

  3. Unzip the package and move to the preferred directory to execute automation tests.

  • macOS: If you currently use macOS Catalina, you have to enable Katalon Studio Engine application in System Preferences/ Security & Privacy/ General.

  • Linux: Be sure to install OpenJDK 8 on your Ubuntu (NOT Oracle JDK). You can find the installation steps here. Once you finish the installation, your OpenJDK information is displayed when you execute java -version command.

    • Troubleshoot: You may encounter the NoClassDefFoundError error since Oracle JDK is being used. Please uninstall Oracle JDK, and then install Open JDK8.

RE Licensing

You need a valid RE license to use this add-on. RE license is a node-locked license. The number of licenses to acquire should be based on the number of processes and the maximum parallel sessions that you plan to execute.

  • A license is linked to a single machine ID and for one execution session.
  • A machine can be mapped to multiple licenses (if needed).
  • The license can be transferred to a new machine for an online environment. For the offline environment, once converted, the license cannot be transferred to another machine until it is expired.

Learn more about RE License.

Activate RE

To activate RE, there are different activation methods based on the execution environment which can be online or offline. Learn more.

Once ready, navigate to the RE directory and execute the Katalon automation test in command-line mode (CLI) as normal. Learn more about execution in console mode.

Get Started

To execute tests, follow the following steps:

  • Generate a console mode command. You can generate command directly from the command generator.
  • Copy and paste the generated command in Terminal (macOS, and Linux)/ Command Prompt (Windows).

For example:

./katalonc -noSplash  -runMode=console -projectPath="/home/demokatalon/Katalon Studio/WebTesting/WebTesting.prj" -retry=0 -testSuitePath="Test Suites/TS_RegressionTest" -browserType="Chrome (headless)"

User Contributed Notes