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 download Sysand:

  • From PyPI
  • From this page
  • From GitHub releases
  • Compile from source

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
After downloading the appropriate file, installation depends on your platform:

It is recommended to then verify the installation.

Windows

The downloaded binary can either be installed manually or by running a few PowerShell commands.

Manual installation

  1. Move the downloaded .exe file to %LOCALAPPDATA%\Programs\Sysand\sysand.exe

  2. 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 move to it
mkdir "$env:LOCALAPPDATA\Programs\Sysand" -Force
mv sysand-windows-x86_64.exe "$env:LOCALAPPDATA\Programs\Sysand\sysand.exe"

# For ARM64 systems

# Create directory and move to it
mkdir "$env:LOCALAPPDATA\Programs\Sysand" -Force
mv sysand-windows-arm64.exe "$env:LOCALAPPDATA\Programs\Sysand\sysand.exe"
  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. Make the binary executable and move to a folder in PATH by running the following commands:
# For Intel Macs
chmod +x ~/Downloads/sysand-macos-x86_64
sudo mv ~/Downloads/sysand-macos-x86_64 /usr/local/bin/sysand

# For Apple Silicon Macs
chmod +x ~/Downloads/sysand-macos-arm64
sudo mv ~/Downloads/sysand-macos-arm64 /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. Make the binary executable and move to a folder in PATH by running the following commands:
# For x86_64 systems
chmod +x sysand-linux-x86_64
sudo mv sysand-linux-x86_64 /usr/local/bin/sysand

# For ARM64 systems
chmod +x sysand-linux-arm64
sudo mv sysand-linux-arm64 /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

Download development version

Latest development version of Sysand can be downloaded from GitHub releases by choosing the latest release by date (which is usually labelled starting with “Nightly Release”).

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