How to install the soar-cli crate // Lib.rs

Installing the `soar` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install soar-cli

It will make the soar command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall soar-cli uninstalls.

Back to the crate overview.

Readme

📘 Documentation | 🔮 PackageForge

A fast, modern, bloat-free distro-independent package manager that just works
Supports Static Binaries, AppImages, and other Portable formats on any *Unix-based distro

📦 What is Soar?

Soar is a package manager - it doesn't build or host packages itself. Instead, it consumes package metadata from repositories and handles downloading, installing, and managing packages on your system.

How it works:

Repositories (like pkgforge) build and host packages, providing metadata in a standard format
Soar fetches this metadata, lets you search/install packages, and manages your local installations
You can use the default pkgforge repositories, add third-party ones, or even create your own

This separation means Soar works with any compatible repository - it's not tied to a specific package source.

🪄 Quickstart

[!TIP]

Soar comes as a single-file, statically-linked executable with no dependencies that you can simply download & run.

The install script does this & more automatically for you.

# cURL
curl -fsSL "https://raw.githubusercontent.com/pkgforge/soar/main/install.sh" | sh

# wget
wget -qO- "https://raw.githubusercontent.com/pkgforge/soar/main/install.sh" | sh

[!NOTE]

Please read & verify what's inside the script before running it

The script is also available through https://soar.qaidvoid.dev/install.sh & https://soar.pkgforge.dev/install.sh

Additionally, if you want to customize your installation, please read the docs @ https://soar.qaidvoid.dev/installation.html

For extra guide & information on infra backends & adding more repos: https://docs.pkgforge.dev

Next, check Configuration & Usage

🌟 Key Features

Feature	Description
Universal	Single binary, no dependencies, works on any Unix-like system without superuser privileges.
Portable Formats	Install static binaries, AppImages, and other self-contained archives with ease.
System Integration	Automatically adds desktop entries and icons for a native feel.
Repository Agnostic	Works with any repository that provides compatible metadata. Use official pkgforge repos, third-party sources, or create your own.
Security First	Enforces security through checksums and signature verification for package installations.
Fast & Efficient	Minimal overhead with parallel downloads and efficient package operations.

📀 Default Repositories

Soar comes pre-configured with pkgforge repositories. These are the default package sources, but you can add or replace them with any compatible repository.

🏆 Tier	🤖 Architecture	📦 Repositories
Tier 1	`aarch64-Linux`	bincache, pkgcache
Tier 1	`x86_64-Linux`	bincache, pkgcache
Tier 2	`riscv64-Linux`	bincache, pkgcache

🤝 Contributing

We welcome contributions! Please feel free to fork the repository and submit pull requests. See CONTRIBUTING.md for contribution guidelines.

💬 Contact

We have a growing community on discord to discuss not only Soar/Pkgforge but also other cool projects, feel free to join & hangout anytime.

Other Channels: https://docs.pkgforge.dev/contact/chat

🎀 Sponsors

CICD run on free Github Runners, Container Registry & Package Storage on ghcr.io. These & much more are all generously provided by GitHub
riscv64 CICD test machines are provided by 10x Engineer's Cloud-V

Minimum Supported Rust Version (MSRV)

v1.88.0

Installing the soar executable

Installing the `soar` executable