This version is still in development and is not considered stable yet. For the latest stable version, please use RIOT-X 1.15!

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.

Distributions

Two distributions are released together, with the same version:

riotx

The full distribution: replication (replicate, sync), diff, pubsub, data generation (gen, faker), stream and Redis import/export, file, database, Elasticsearch/OpenSearch, Snowflake and Databricks import/export, stats and ping.

riot

A smaller, Redis-focused distribution built on the reactive engine, with no Spring dependencies: sync, pubsub, diff, gen, stats and ping. These are separate implementations from the riotx commands of the same name (except sync and pubsub, which are the same), so options can differ. JavaScript expressions (--key-proc, --ttl-proc, --channel-proc) are only available in riotx.

The instructions below use riotx; replace it with riot to install the smaller distribution (for example brew install redis/tap/riot or docker run riotx/riot).

Docker

You can run RIOT-X as a docker image:

docker run riotx/riotx [OPTIONS] [COMMAND]

Homebrew (macOS & Linux)

brew install redis/tap/riotx

Recent versions of Homebrew require you to explicitly trust third-party taps before installing from them. If you see an error such as Refusing to load formula redis/tap/riotx from untrusted tap redis/tap, trust the tap first:

brew trust redis/tap

Then re-run the install (or brew upgrade 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-early-access.zip requires Java 17 or greater to be installed.

riotx-standalone-early-access-*.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.