Linux

The rstream CLI can be installed on Linux from the Debian package repository, with the standalone shell installer, through npm, or by running the published Docker image.

For Debian, Ubuntu, Raspberry Pi OS, and other APT-based environments, the Debian package is the preferred path. It installs system-wide and keeps upgrades in the normal APT workflow.

Install with the Debian package

sudo /bin/bash -i -c "$(curl -fsSL https://rstream.io/scripts/install-debian.sh)"

The installer registers the rstream APT source at https://debian.rstream.io/linux, imports the rstream signing key, refreshes the package index, and installs the rstream package. It also installs the package-management prerequisites it needs, such as curl, gnupg, and apt-transport-https, when they are missing.

After installation, verify the CLI:

rstream --version

Install with the shell installer

The shell installer is useful for generic Linux hosts, minimal images, and environments where registering an APT source is not wanted. It detects the operating system and CPU architecture, downloads the matching release, and links the CLI under a local prefix.

/bin/sh -i -c "$(curl -fsSL https://rstream.io/scripts/install.sh)"

When /opt/rstream is writable, the installer uses it as the installation prefix. Otherwise it installs under ~/.rstream and prints the PATH update needed for interactive shells.

Install with npm

Node.js-based environments can install the CLI through npm:

npm install -g @rstreamlabs/rstream-cli

Run from Docker

The CLI is also published as a Docker image. This is convenient in CI, ephemeral jobs, or hosts where installing binaries is undesirable.

docker run --rm -it rstream/rstream:latest --help

The image can run forward directly when an engine endpoint and token are provided:

docker run --rm -it -e RSTREAM_AUTHENTICATION_TOKEN="<token>" -e RSTREAM_ENGINE="<engine>" rstream/rstream:latest forward 8080