Installing ReadyAPI from the Command Line

Applies to ReadyAPI 3.8, last modified on May 13, 2021

This page explains how to install ReadyAPI from the command line.

For a typical installation process, see Installation Guide.

To learn how to install VirtServer, see VirtServer Installation.

Before installing

To run ReadyAPI, your computer must meet certain system requirements.

Also, you will need either a ReadyAPI trial license or a commercial Pro license for one or for all ReadyAPI tools (ReadyAPI Test, ReadyAPI Performance, ReadyAPI Virtualization). A Pro license for one of the tools enables basic functionality of the other ones.

Before the first ReadyAPI run, you need to install a license.

For current ReadyAPI users:

  • If you have an active license of ReadyAPI, you do not need to activate a new license.

  • VirtServer requires a separate license.

Ubuntu prerequisites

If you install ReadyAPI on the Ubuntu operating system, you should run the following command to avoid an error during the installation:

sudo apt-get install fontconfig

Download installer

Visit the ReadyAPI Downloads Center and download the ReadyAPI Linux installer of the desired bitness. This package includes JDK, so you can use it on a machine without installed Java. To install ReadyAPI on a headless machine, follow the instructions below.

To download a package on a headless machine, you can use curl or a similar tool:

curl https://dl.eviware.com/ready-api/3.8.0/ReadyAPI-x64-3.8.0.exe -o ~/Downloads/ReadyAPI-x64-3.8.0.exe

curl https://dl.eviware.com/ready-api/3.8.0/ReadyAPI-x64-3.8.0.sh -o ~/Downloads/ReadyAPI-x64-3.8.0.sh

curl https://dl.eviware.com/ready-api/3.8.0/ReadyAPI-x64-3.8.0.dmg -o ~/Downloads/ReadyAPI-x64-3.8.0.dmg

Installation steps

The following instruction describes the process of installing ReadyAPI on a headless machine.

  1. Prepare the installation file:

    There is no need to prepare the installation file on Windows computers.

    Make the downloaded file executable:

    chmod +x ./ReadyAPI-x64-3.8.0.sh

    Mount the ReadyAPI image:

    hdiutil attach ~/Downloads/ReadyAPI-3.0.0.dmg

  2. Run the installer with the -c argument:

    start /wait ReadyAPI-x64-3.8.0.exe -c

    ./ReadyAPI-x64-3.8.0.sh -c

    "/Volumes/ReadyAPI/ReadyAPI 3.8.0 Installer.app/Contents/MacOS/JavaApplicationStub" -c

  3. If ReadyAPI is already installed on your computer, you will be asked whether you want to update the current installation or to install the product anew to a different directory.

  4. After the installation is complete, you can run ReadyAPI command-line tools to run tests:

Command-line arguments

Below is a short list of command-line parameters you can use to install ReadyAPI on a headless machine. For the complete list of parameters, see install4j help.

  • -h, -help, or /?: Displays the list of available command-line arguments.

  • -manual: Commands the installer to act as if no JRE has been found and displays the dialog where you can choose a JRE or download one if a JRE has been bundled dynamically. If you locate a JRE, it will be used for the installed tool.

    You can apply this parameter to Microsoft Windows only.
  • -c: Executes the installer in the console mode, that is, the interaction with the user is performed in the terminal from which the installer was invoked.

  • -q: Executes the installer in the unattended mode, that is, there is no interaction with the user and the installation is performed automatically with the default values.

  • -g: Executes the installer in the GUI mode.

    Tip: Use this parameter if you configured the installer default execution mode as the console or unattended one.
  • -console: Displays the installer output, if the installer is executed in the unattended mode and the -console parameter is passed after the -q parameter.

    Tip: Use this for debugging.
  • -overwrite: Lets the installer overwrite the existing file. Only valid if -q is set.

  • -wait [timeout in seconds]: Defines the time to wait before all installed launchers and installer applications, including the updater, shut down. If this does not happen before the timeout expires, the installer exits with an error message. Only valid if -q is set.

  • -dir [directory]: Sets a custom installation directory (absolute or relative) for the unattended installation mode. If the directory is relative, it will be resolved relative to the media type. Only valid if -q is set.

    Note: Specify the path to the directory in quotes.
  • -splash [title]: Specifies the title of the window with a progress bar that will be shown during the installation in the unattended installation mode. Only valid if -q is set.

To uninstall ReadyAPI from a headless machine, do the following:

Run the uninstallation script:

start /wait <ReadyAPI folder>/uninstall -c

Below is a short list of command-line parameters you can use to uninstall ReadyAPI on a headless machine:

  • -c: Executes the uninstaller in the console mode, that is, the interaction with the user is performed in the terminal from which the installer was invoked.

  • -q: Executes the uninstaller in the unattended mode, that is, there is no interaction with the user and the uninstallation is performed automatically with the default values.

  • -h: Displays the list of available command-line arguments.

Run the uninstallation script:

<ReadyAPI folder>/uninstall -c

Below is a short list of command-line parameters you can use to uninstall ReadyAPI on a headless machine:

  • -c: Executes the uninstaller in the console mode, that is, the interaction with the user is performed in the terminal from which the installer was invoked.

  • -q: Executes the uninstaller in the unattended mode, that is, there is no interaction with the user and the uninstallation is performed automatically with the default values.

  • -h: Displays the list of available command-line arguments.

Use the following commands to uninstall ReadyAPI:

rm -rf "/Applications/ReadyAPI-3.8.0.app"
cd ~/Desktop/
rm -rf "ReadyAPI 3.8.0"

You can run these commands one by one in the terminal, or combine them in a script file to run in the unattended mode.

See Also

General Information
System Requirements
VirtServer Installation

Highlight search results