Install

RIOT-X can be installed on Linux, macOS, and Windows platforms and can be used as a standalone tool that connects remotely to a Redis database. It is not required to run locally on a Redis server.

Docker

You can run RIOT-X as a docker image:

docker run riotx/riotx [OPTIONS] [COMMAND]

Homebrew (macOS & Linux)

brew install redis/tap/riotx

Scoop (Windows)

scoop bucket add redis https://github.com/redis/scoop.git
scoop install riotx

Manual Installation (All Platforms)

Download the pre-compiled binary from RIOT-X Releases, uncompress and copy to the desired location.

riotx-1.7.0.zip requires Java 11 or greater to be installed.

riotx-standalone-1.7.0-*.zip includes its own Java runtime and does not require a Java installation.

Linux & macOS

After downloading and extracting the archive:

# Extract the archive
unzip riotx-standalone-{page-component-version}-*.zip

# Move to desired location (optional)
sudo mv riotx-standalone-{page-component-version} /opt/riotx

# Add to PATH (add to ~/.bashrc or ~/.zshrc for persistence)
export PATH=$PATH:/opt/riotx/bin

Windows

After downloading the archive:

  1. Extract the ZIP file to a location such as C:\Program Files\riotx

  2. Add the bin directory to your PATH:

    • Open System Properties → Advanced → Environment Variables

    • Under System Variables, find and select Path, then click Edit

    • Click New and add C:\Program Files\riotx\bin

    • Click OK to save

You can now run riotx from any Command Prompt or PowerShell window.