Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

There are a few ways to install Sysand:

  • By installing the sysand Python package from PyPI
  • By downloading a sysand binary manually or with an installation script
  • By compiling Sysand from its source code

PyPI

Sysand is published to PyPI and includes both the CLI and Sysand Python library.

We recommend installing from PyPI into an isolated (virtual) environment. This can be done with pipx:

pipx install sysand

Or with uv:

uv tool install sysand

Note

pipx/uv tool will make only the CLI part of the package accessible

Both Sysand CLI and Python library can be installed with pip:

pip install sysand

Tip

pip is sometimes called pip3, so if pip command is not available, try pip3

Or with uv (run inside a virtual environment):

uv pip install sysand

Download latest release

Latest official Sysand CLI release can be downloaded below or from latest GitHub release.

Windows macOS Linux
x86_x64
ARM64

The download is an archive (.zip on Windows, .tar.gz on macOS and Linux) containing a single sysand executable (sysand.exe on Windows). After downloading, extract the archive and follow the steps for your platform:

It is recommended to then verify the installation.

Windows

The downloaded .zip archive contains sysand.exe. It can either be installed manually or by running a few PowerShell commands.

Manual installation

  1. Right-click the downloaded .zip file and choose “Extract All…”
  2. Move the extracted sysand.exe to %LOCALAPPDATA%\Programs\Sysand\sysand.exe
  3. Add to PATH via Environment Variables:
    1. Open “Environment Variables” (search in Start menu)
    2. Under “User variables”, select “Path” and click “Edit”
    3. Click “New” and add %LOCALAPPDATA%\Programs\Sysand
    4. Click “Ok” to save

PowerShell installation

  1. Open PowerShell
  2. Run these commands:
# For x86_64 systems

# Create directory and extract the archive into it
mkdir "$env:LOCALAPPDATA\Programs\Sysand" -Force
Expand-Archive -Path sysand-windows-x86_64.zip `
  -DestinationPath "$env:LOCALAPPDATA\Programs\Sysand" -Force

# For ARM64 systems

# Create directory and extract the archive into it
mkdir "$env:LOCALAPPDATA\Programs\Sysand" -Force
Expand-Archive -Path sysand-windows-arm64.zip `
  -DestinationPath "$env:LOCALAPPDATA\Programs\Sysand" -Force
  1. Add folder to PATH:
# Add to PATH
$currentPath = [Environment]::GetEnvironmentVariable("Path", "User")
$newPath = "$env:LOCALAPPDATA\Programs\Sysand"
if ($currentPath -notlike "*$newPath*") {
   [Environment]::SetEnvironmentVariable("Path", "$currentPath;$newPath", "User")
}

Important

Restart your terminal after installation for PATH changes to take effect.

macOS

System installation (requires sudo)

  1. Open Terminal
  2. Extract the archive and move the sysand binary to a folder in PATH by running the following commands:
# For Intel Macs
tar -xzf ~/Downloads/sysand-macos-x86_64.tar.gz -C ~/Downloads
sudo mv ~/Downloads/sysand /usr/local/bin/sysand

# For Apple Silicon Macs
tar -xzf ~/Downloads/sysand-macos-arm64.tar.gz -C ~/Downloads
sudo mv ~/Downloads/sysand /usr/local/bin/sysand

Alternative: user installation (no sudo required)

It is also possible to install without sudo rights, but that requires additional steps.

  1. Run in Terminal:
# Create local bin directory if it doesn't exist
mkdir -p ~/.local/bin

# Add local bin directory to PATH in your shell profile
# (default ~/.zshrc, but could be ~/.bashrc etc.)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
  1. Move the executable as shown above for the system installation, but instead of /usr/local/bin/sysand move to ~/.local/bin/sysand.

Linux

System installation (requires sudo)

  1. Open a terminal
  2. Extract the archive and move the sysand binary to a folder in PATH by running the following commands:
# For x86_64 systems
tar -xzf sysand-linux-x86_64.tar.gz
sudo mv sysand /usr/local/bin/sysand

# For ARM64 systems
tar -xzf sysand-linux-arm64.tar.gz
sudo mv sysand /usr/local/bin/sysand

Alternative: user installation (no sudo required)

It is also possible to install without sudo rights, but that requires additional steps.

  1. Run in a terminal:
# Create local bin directory if it doesn't exist
mkdir -p ~/.local/bin

# Add local bin directory to PATH in your shell profile (~/.bashrc, ~/.zshrc, etc.)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
  1. Move the executable as shown above for the system installation, but instead of /usr/local/bin/sysand move to ~/.local/bin/sysand.

Verify the installation

Run in a terminal:

sysand --version

You should see an output similar to: sysand X.Y.Z

Installation script

Sysand provides a script to download and install sysand.

The scripts download the official GitHub Release archive for your platform, extract the sysand executable, and copy it into an install directory. By default, latest means the latest non-prerelease GitHub release. To install a prerelease, pass an explicit version.

The scripts do not edit your shell profile or PATH settings. If the install directory is not already on PATH, the script prints a note after installation.

Windows

The default install directory is %LOCALAPPDATA%\Programs\Sysand. On Windows, the PATH note checks your user Path setting.

Download, inspect, then run the script:

Invoke-WebRequest https://client.sysand.com/install.ps1 -OutFile install.ps1
notepad install.ps1
powershell -ExecutionPolicy Bypass -File .\install.ps1

Or run it directly:

irm https://client.sysand.com/install.ps1 | iex

To install a specific release version, use -Version. The leading v is optional.

.\install.ps1 -Version 0.1.0
.\install.ps1 -Version 0.1.0-rc.1
.\install.ps1 -Version v0.1.0-rc.1

To choose a different install directory:

.\install.ps1 -InstallDir "$env:USERPROFILE\bin"

Download the script first when passing -Version or -InstallDir.

macOS and Linux

The default install directory is $HOME/.local/bin.

Download, inspect, then run the script:

curl -fsSLO https://client.sysand.com/install.sh
less install.sh
sh install.sh

Or run it directly:

curl -fsSL https://client.sysand.com/install.sh | sh

To install a specific release version, use --version. The leading v is optional.

sh install.sh --version 0.1.0
sh install.sh --version 0.1.0-rc.1
sh install.sh --version v0.1.0-rc.1

To choose a different install directory:

sh install.sh --install-dir "$HOME/bin"

To install into /usr/local/bin, use --system-install. If the current user is not root, the install step uses sudo.

sh install.sh --system-install

Flags can also be passed when piping the script:

curl -fsSL https://client.sysand.com/install.sh | sh -s -- --install-dir "$HOME/bin"

Download development version

Latest development version of Sysand can be downloaded from the nightly GitHub release.

Warning

Nightly assets are not signed and so may be prevented from running by antivirus software.

Compiling from source code

Sysand is written in Rust programming language and so can be installed using cargo. Cargo is part of Rust language tooling. If you have it, run the following command in the terminal:

cargo install sysand --git=https://github.com/sensmetry/sysand.git