Skip to main content

Supported rl-deploy commands

Learn more about supported rl-deploy commands.

Generally, the commands produce detailed, actionable output with recommendations for next steps.

You can always access inline help in your terminal with rl-deploy help, or with rl-deploy command-name --help for specific commands.

install​

Description​

Downloads the latest rl-secure version from ReversingLabs, installs it, and activates the license.

The rl-deploy install command helps you:

  • Install the rl-secure CLI in CI/CD environments, containers, and similar ephemeral systems with the site key option

  • Install the rl-secure CLI on systems that require a proxy connection with persistent proxy configuration parameters

  • Install the rl-secure CLI from the cached installation file

  • Choose the format in which you want to specify your license: as a file or as a Base64-encoded string directly in the command

The primary use-case for the rl-deploy install command is to enable fast and flexible deployment of rl-secure on short-lived, temporary machines used in modern CI/CD processes. However, you can also use it to install rl-secure on any other supported system.

Prevent issues with permissions

Make sure to run the rl-deploy install command with the same permissions that will be used to run rl-secure after it's installed.

Usage​

rl-deploy install <install-location> <license-file-or-encoded-key> [<options>]

Options​

OptionDescription
--from-cachePath to the local cached installation file. When specified, rl-deploy checks the local cache and uses the file to install rl-secure. As rl-secure performs an automatic update on each scan, this file needs to be regenerated with each new version of rl-secure. If the file is not found, this option is ignored and the latest rl-secure version is downloaded from the cloud.
--locationRequired. Path to the directory where you want to install rl-secure. When specifying the path, make sure the current user has permissions to access and write into the specified directory. If the directory doesn't exist yet, it is created automatically. If rl-secure is already installed into the specified directory, the command will fail.
--license-filePath to the license file you received from ReversingLabs - an alternative to providing the license file as a Base64-encoded string. The license file must be on the local filesystem. This option can be used together with --site-key. It is mutually exclusive with --encoded-key.
--encoded-keyBase64-encoded contents of the license file - an alternative to providing the path to the license file. To use this option, you must first encode the contents of your license file, and provide the resulting string to this option. It can be used together with --site-key, and it's mutually exclusive with --license-file.
--site-keyOptional value to be used with the license when installing rl-secure on systems without a stable machine number. The site key is generated by ReversingLabs and sent to users with the license file. This option can be used with either --license-file or with --encoded-key.
--no-trackingDon't display progress bars.
-h, --helpDisplay usage information and exit.

Proxy configuration options

If you use any proxy settings during the installation, they are automatically saved to the rl-secure configuration file. That way, rl-secure can continue using them when it needs to connect to ReversingLabs servers.

You can change those settings at any time after the installation with the rl-secure config command, or by manually editing the config.info file.

OptionDescription
--proxy-serverOptional. Use it to provide the server URL for local proxy configuration.
--proxy-portOptional. Use it to provide the network port for local proxy configuration.
--proxy-userOptional. Use it to provide the user name for proxy authentication. Must be used together with --proxy-password.
--proxy-passwordOptional. Use it to provide the password for proxy authentication. Must be used together with --proxy-user.

Examples​

Install rl-secure with the license file​

In this example, we're installing rl-secure and providing the path to the license file. We're not using the site key because we previously requested a license based on the machine number. This is the same approach as in the rl-secure installation guide. The difference is that we don't need to manually download or unpack any installation packages for rl-secure, and we don't have to manually activate the license.

The installation requires an internet connection so that rl-deploy can download the installation files and connect to ReversingLabs servers to verify your license.

To make sure the installation and license activation succeeded, you can run rl-secure license status after the command in this example. The output should indicate that your license is valid and show your analysis capacity for the current time period.

rl-deploy install --location /opt/rl-secure --license-file /home/user/Downloads/license.bin

Cached installation​

In this example, we're installing rl-secure from the cached installation file and providing the path to the license file.

By default, rl-deploy install downloads the rl-secure package from ReversingLabs servers to perform a fresh install. This approach can be slow and inefficient for ephemeral configurations, because running install repeatedly requires downloading the rl-secure package every time. To skip the download process, rl-deploy can perform the installation of rl-secure from a local cached installation file.

Cached installation requires two steps:

  1. Create a cached installation file of the latest rl-secure version by using the rl-deploy cache command
  2. Use that cached file during the installation

The installation requires an internet connection so that rl-deploy can connect to ReversingLabs servers to verify your license.

To make sure the installation and license activation succeeded, you can run rl-secure license status after the command in this example. The output should indicate that your license is valid and show your analysis capacity for the current time period.

1. Generate a cached installation file

rl-deploy cache --location /path/to/cache.file --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key

2. Use the cached file to perform installation

rl-deploy install --from-cache /path/to/cache.file --location /path/to/destination/ --encoded-key=your-license-contents-as-BASE64-encoded-string --site-key=your-site-key

license​

Description​

Displays the unique machine number for the current machine.

To use the rl-secure CLI, you need a valid, activated license. The license is generated by ReversingLabs on user request.

The following license types are supported:

  • Single-machine license

To install rl-secure on individual workstations, you should copy the machine number from the rl-deploy license command output and send it to ReversingLabs Support in your license request email. This process is described in the rl-secure licensing guide.

  • Site-wide deployment license

If you plan to install rl-secure on ephemeral systems, you should use the site key option supported by rl-deploy. In that case, there is no need to send the machine number to ReversingLabs when requesting a license, because the license will be generated in a way that supports site key usage. This process is described in the rl-secure licensing guide.

Usage​

rl-deploy license

This command does not have any options. It does not show any information about your account or analysis capacity usage. Use the rl-secure license command for that.

Examples​

Show the machine number​

In this example, we're using the rl-deploy license command to display the serial number of the current machine.

rl-deploy license

cache​

Description​

Creates a cached installation file of the latest rl-secure version. Using this command skips the slow and tedious process of downloading the rl-secure package every time you want to install the latest rl-secure version on ephemeral configurations.

The rl-deploy cache command will connect to the official update servers using your provided license information and download the cached package to a location of your choice.

Note that your license information is used only for access control. It is not embedded inside the cached installation package.

This command does not install the latest rl-secure version. To do that, you need to use the rl-deploy install command with relevant options.

Usage​

rl-deploy cache <cached-file> <license-file-or-encoded-key> [<options>]

Options​

OptionDescription
--locationRequired. Path to the cached rl-secure installation file you're creating. When specifying the path, make sure the current user has permissions to access and write into the specified directory.
--license-filePath to the license file you received from ReversingLabs - an alternative to providing the license file as a Base64-encoded string. The license file must be on the local filesystem. This option can be used together with --site-key. It is mutually exclusive with --encoded-key.
--encoded-keyBase64-encoded contents of the license file - an alternative to providing the path to the license file. To use this option, you must first encode the contents of your license file, and provide the resulting string to this option. It can be used together with --site-key, and it's mutually exclusive with --license-file.
--site-keyOptional value to be used with the license when installing rl-secure on systems without a stable machine number. The site key is generated by ReversingLabs and sent to users with the license file. This option can be used with either --license-file or with --encoded-key.
--no-trackingDon't display progress bars.
-h, --helpDisplay usage information and exit.