Skip to content

Quick Start Guide ​

Get Soar installed and managing packages in under five minutes.

First Time Setup ​

Step 1: Install Soar ​

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

Step 2: Verify Installation ​

sh
soar --version

Step 3: Add to PATH ​

sh
echo 'export PATH="$HOME/.local/bin:$HOME/.local/share/soar/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
sh
echo 'export PATH="$HOME/.local/bin:$HOME/.local/share/soar/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Step 4: Install Your First Package ​

sh
soar sync
soar install neovim

Need more options?

See the Installation Guide for manual installs, custom directories, and version pinning.

Daily Package Management ​

Search Packages ​

sh
soar search python
soar query neovim

Install Packages ​

sh
soar install git
soar install git curl wget
soar install https://example.com/package.AppImage

List Packages ​

sh
soar list
soar info

Update Packages ​

sh
soar update
soar update neovim git

Remove Packages ​

sh
soar remove neovim

Run Without Installing ​

sh
soar run neovim

Switching from Another Package Manager ​

From apt (Debian/Ubuntu) ​

Taskapt CommandSoar Equivalent
Update cachesudo apt updatesoar sync
Installsudo apt install <pkg>soar install <pkg>
Removesudo apt remove <pkg>soar remove <pkg>
Updatesudo apt upgradesoar update
Searchapt search <query>soar search <query>
List installedapt list --installedsoar info

From pacman (Arch Linux) ​

Taskpacman CommandSoar Equivalent
Update databasesudo pacman -Sysoar sync
Installsudo pacman -S <pkg>soar install <pkg>
Removesudo pacman -R <pkg>soar remove <pkg>
Update systemsudo pacman -Syusoar update
Searchpacman -Ss <query>soar search <query>
List installedpacman -Qesoar info

Managing Multiple Systems ​

Profiles let you maintain separate package environments.

Create a Profile ​

Edit ~/.config/soar/config.toml:

toml
[profile.default]
root_path = "~/.local/share/soar"

[profile.dev]
root_path = "~/dev-tools"

Use Profiles ​

sh
soar --profile dev install neovim
soar --profile dev list
soar --profile dev update

Set Default Profile ​

toml
default_profile = "dev"

Troubleshooting ​

Run diagnostics if something is not working:

sh
soar health

For comprehensive troubleshooting, see Health & Diagnostics.

What's Next? ​

Released under the MIT License.