Logo

Install rstream CLI

rstream CLI is available for Linux, macOS, and Windows across most hardware architectures, supporting multiple installation methods including package managers, One-Command Install scripts, direct download, and Docker images.

Need advanced monitoring tools? Check out rstream utils for Linux and macOS.

On Linux, we recommend using APT to install rstream. Alternatively, you can install rstream using the One-Command Install script, or via NPM.

  1. Using APT
  2. One-Command Install using Bash
  3. Using NPM

Using APT (Recommended Method)

  1. Install

    Copy paste the following command into a Bash terminal window to initiate the installation process.

    The script will download and install the latest version of rstream. Detailed installation options can be found in our documentation.

  2. Configure

    Configure your rstream client by adding your authentication token. This can be found in your dashboard.

    Please create an account if you do not have one yet to receive your authentication token.

  3. Run

    Once set up you are ready to start using rstream !

    This last command will forward all incoming traffic to port 8080 of your local machine.

  4. Go Further

    Explore essential commands and more in our comprehensive Quick Start Guide.

One-Command Install using Bash (Alternative Method)

  1. Install

    Copy paste the following command into a Bash terminal window to initiate the installation process.

    The script will download and install the latest version of rstream. Detailed installation options can be found in our documentation.

Using NPM (Alternative Method)

  1. Install

    Install rstream through npm.

Frequently asked questions

Can’t find the answer you’re looking for? Reach out to our customer support.

rstream is compatible with Linux, macOS, and Windows. Additionally, rstream supports other UNIX systems such as FreeBSD and NetBSD through manual installation.

rstream is available through various package managers for macOS (homebrew, npm), Linux (apt, npm), and Windows (chocolatey, npm). rstream can also be installed on these platforms via a One-Command Install script. Alternatively, rstream can be used via Docker, or even be installed manually if you need more control over the installation process, for example, to integrate rstream into an existing workflow.

No, you do not need to be a superuser to install or use rstream. However, administrator rights are required if you wish to install rstream for all users using One-Command Install script. The script automatically determines the installation path based on the permissions with which it is executed.

Yes, to utilize rstream, you are required to create an account. This ensures a personalized experience and enables access to all features and functionalities of the tool. Setting up an account also aids in providing enhanced security and support.

rstream is provided as a standalone binary and hence does not have any specific dependencies. However, the One-Command Install script is available for both Bash and PowerShell.

If you have installed rstream via a package manager, or via docker, please refer to the associated procedure to update rstream. If you have installed rstream via the One-Command Install script, then simply re-run the installation command to automatically update rstream. rstream periodically checks if a newer version is available and will notify you in the logs when a new version is available.

The rstream CLI cannot be used directly on a mobile environment. However, if you wish to integrate rstream into a mobile application, you can cross-compile the C++ or Go SDK (once available) for your mobile platform and incorporate it into your app.