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

Install Soar on your Linux system using one of the following methods.

Prerequisites: Linux (any distribution), curl or wget, basic shell access.

System Requirements

  • Architectures: x86_64, aarch64, riscv64
  • OS: Any Linux distribution (kernel 4.0+ recommended)
  • Building from source: Rust 1.88.0+

Quick Installation

curl -fsSL https://soar.qaidvoid.dev/install.sh | sh

Or with wget:

wget -qO- https://soar.qaidvoid.dev/install.sh | sh

The script automatically detects your architecture, downloads the appropriate binary, and installs it to:

  • /usr/local/bin (if running as root)
  • $HOME/.local/bin (user installation, default)

Install Script Options

VariablePurposeExample
SOAR_VERSIONSpecify versionlatest, nightly, 0.4.0
SOAR_INSTALL_DIRCustom directory/usr/local/bin, $HOME/.local/bin
DEBUGEnable debug outputSet to any value

Examples:

# Install specific version
curl -fsSL https://soar.qaidvoid.dev/install.sh | SOAR_VERSION=0.4.0 sh

# Install to custom directory
curl -fsSL https://soar.qaidvoid.dev/install.sh | SOAR_INSTALL_DIR=$HOME/.local/bin sh

# Enable debug output
curl -fsSL https://soar.qaidvoid.dev/install.sh | DEBUG=1 sh

Manual Installation

From Pre-built Binaries

  1. Download from releases

  2. Choose your architecture:

    • soar-x86_64-linux (Intel/AMD)
    • soar-aarch64-linux (ARM 64-bit)
    • soar-riscv64-linux (RISC-V 64-bit)
  3. Install:

chmod +x soar-x86_64-linux
sudo mv soar-x86_64-linux /usr/local/bin/soar

From Cargo

cargo install soar-cli

Requires Rust toolchain. Takes longer due to compilation.

Building from Source

git clone https://github.com/pkgforge/soar.git
cd soar
cargo install --path .

Requires Rust 1.88.0+.

PATH Configuration

Two directories should be in your PATH:

  • $HOME/.local/bin — where the soar binary is installed
  • $HOME/.local/share/soar/bin — where packages installed by Soar are symlinked
# Add both to PATH (Bash/Zsh)
echo 'export PATH="$HOME/.local/share/soar/bin:$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Uninstallation

Remove Soar

# User installation
rm ~/.local/bin/soar
rm -rf ~/.config/soar ~/.local/share/soar

# System installation
sudo rm /usr/local/bin/soar
sudo rm -rf /etc/soar /opt/soar

Or use the self-uninstall command:

soar self uninstall

Remove Packages

soar remove ffmpeg
soar remove --all

Troubleshooting

“Command not found” after installation:

  1. Verify binary exists: ls -la ~/.local/bin/soar
  2. Check PATH: echo $PATH
  3. Add to PATH (see PATH Configuration)
  4. Restart shell: source ~/.bashrc

“Permission denied” installing:

  • Use user installation: SOAR_INSTALL_DIR=$HOME/.local/bin
  • Or use sudo: sudo curl -fsSL https://soar.qaidvoid.dev/install.sh | sh

Download fails:

  • Try alternative CDN: curl -fsSL https://soar.pkgforge.dev/install.sh | sh
  • Use wget: wget -qO- https://soar.qaidvoid.dev/install.sh | sh
  • Download manually from GitHub releases

Build from source fails:

  • Check Rust version: rustc --version (requires 1.88.0+)
  • Update Rust: rustup update
  • Install dependencies: sudo apt install build-essential pkg-config libssl-dev

For more help, run soar health check verbose output with --verbose, or visit GitHub Issues.

Next Steps

# Verify installation
soar --version

# Sync repositories
soar sync

# Install your first package
soar install ffmpeg