Skip to content

Getting Started

To get started using the RIM-Tool, please follow the below instructions. The tool can be either installed from a package or built from source.

Installation

Info

Currently, installation from a package is only supported on Linux.

Packages for this tool can be found on the GitHub release page .

Only .rpm (Red Hat Enterpise Linux 9, Rocky Linux 9) and .deb (Debian, Ubuntu) packages are currently supported.

Linux

To install from a package, download from the above link, then run the following (replace the asterisk with the full name of the downloaded package):

sudo dnf install rim-tool*.rpm

sudo apt-get install rim-tool*.deb

After installation, the package will create a command-line shortcut. This can be invoked using the rim command. See Commands for further details.

Building

The RIM-Tool is written using Java, and requires JDK 17 to be installed.

The following sections also assume the RIM-Tool source code has been cloned (using Git) to a local directory.

Note

Please clone using git clone --recursive to initialize any submodules.

Upon successful build, a rim-tool-X.X.jar file will be placed in either the /build/libs/tools/ (Linux) or \build\libs\tools\ (Windows) folders. This can then be run using: 

java -jar <build directory>/rim-tool-X.X.jar

Linux

To build this tool, navigate to the source directory and use the following command: 

./gradlew clean build

Windows

Several options exist for building on Windows 11. In either case, first navigate to the source directory, then run the following:

gradlew.bat clean build

./gradlew clean build

Note

The PowerShell option requires Windows Subsystem for Linux (WSL) to be enabled.

Packaging

To create a Linux installation package for the RIM-Tool, run the following command in the source directory:

./gradlew buildRpm

./gradlew buildDeb

The output package can be found under the /build/distributions/ folder.