Skip to content

Installation Guide

Get the latest Resource Surveillance & Integration Engine (surveilr) for Critical Systems by following these steps to complete the installation:

📦 Package Managers (Recommended)

Ubuntu/Debian (.deb packages)

Terminal window
# Ubuntu (Jammy)
$ wget https://github.com/surveilr/packages/releases/latest/download/surveilr_jammy.deb
$ sudo dpkg -i surveilr_jammy.deb


# Debian (Bookworm)
$ wget https://github.com/surveilr/packages/releases/latest/download/surveilr_bookworm.deb
$ sudo dpkg -i surveilr_bookworm.deb

macOS (Homebrew)

Terminal window
$ brew tap surveilr/tap && brew install surveilr

Windows

Terminal window
# Recommended: Use installation script
$ irm https://raw.githubusercontent.com/surveilr/packages/refs/heads/main/scripts/install.ps1 | iex


# Alternative: Manual installation
# 1. Download from: https://github.com/surveilr/packages/releases/latest
# 2. Extract the downloaded zip file
# 3. Copy the executable (ends with .exe) to your desired directory
# 4. Add to PATH or run from the directory

🔗 Direct Download

Visit our GitHub Releases page to download pre-built binaries for your operating system:

  • Windows: surveilr-windows.zip
  • macOS: surveilr-macos.zip
  • Linux: surveilr-linux.tar.gz

📜 Installation Scripts

macOS and Linux

Terminal window
# Install in current directory
$ curl -sL https://raw.githubusercontent.com/surveilr/packages/main/scripts/install.sh | bash


# Install globally
$ curl -sL https://raw.githubusercontent.com/surveilr/packages/main/scripts/install.sh | SURVEILR_HOME="$HOME/bin" bash


# Install in preferred path
$ curl -sL https://raw.githubusercontent.com/surveilr/packages/main/scripts/install.sh | SURVEILR_HOME="/path/to/directory" bash

🛠️ Alternative Installation Using Eget

Terminal window
# Install eget first
$ curl https://zyedidia.github.io/eget.sh | sh


# Install surveilr
$ eget surveilr/packages --asset tar.gz

After installation, run verification steps below.

Verify installation

Run the following command to verify that surveilr is installed correctly:

Terminal window
$ surveilr --version                      # version information
$ surveilr doctor                         # dependencies that surveilr uses
$ surveilr --help                         # get CLI help (pay special attention to ENV var names)

Checkout more commands in the reference section

Upgrading surveilr

The following commands shows how to upgrade surveilr on your:

Terminal window
$ surveilr upgrade ## Upgrades to the latest version


$ surveilr upgrade -v 0.13.0 ## Upgrades to version 0.13.0 if present

When using the command above, you will be prompted to confirm the upgrade by typing yes. However, if you are running the upgrade in a bash script, you won’t be able to provide this confirmation interactively. To address this, we have provided the --yes or --y flag, which automatically skips the confirmation step. Here is how to use it:

Terminal window
## Upgrades to the latest version and skips confirmation
$ surveilr upgrade --yes


## Upgrades to version 0.1.2 if present and  skips the confirmation
$ surveilr upgrade -v 0.13.0 --yes

Downgrading surveilr

The following commands shows how to downgrade surveilr to any version:

Terminal window
$ surveilr upgrade -v 0.12.0 ## downgrades to version 0.12.0

This takes the same form as the upgrade command with the only difference being that a lower version is passed.