Skip to content

Quick Start

How to install surveilr

Start using surveilr by following the quick guide below:

  • macOS and Linux:

    • Install surveilr in desired path by running any of the following commands:

      Terminal window
      # install in current path
      $ curl -sL https://raw.githubusercontent.com/opsfolio/releases.opsfolio.com/main/surveilr/install.sh | bash
      

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

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

    • Verify installation

  • Windows:

    • Install surveilr by executing the following command in windows powershell terminal

      Terminal window
      $ irm https://raw.githubusercontent.com/opsfolio/releases.opsfolio.com/refs/heads/main/surveilr/install.ps1 | iex

    • Verify installation

Still Got Questions ?

Check out our FAQ