Quick Start Guide
Get started with Soar in under 5 minutes.
First Time Setup
Step 1: Install Soar
curl -fsSL https://soar.qaidvoid.dev/install.sh | sh
Step 2: Verify Installation
soar --version
Step 3: Add to PATH
echo 'export PATH="$HOME/.local/share/soar/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
Step 4: Install Your First Package
soar sync
soar install neovim
Need more options? See Installation Guide
Daily Package Management
Search Packages
soar search python
soar query neovim
Install Packages
soar install git
soar install git curl wget
soar install https://example.com/package.AppImage
List Packages
soar list
soar info
Update Packages
soar update
soar update neovim git
Remove Packages
soar remove neovim
Run Without Installing
soar run neovim
Switching from Another Package Manager
From apt (Debian/Ubuntu)
| Task | apt Command | Soar Equivalent |
|---|---|---|
| Update cache | sudo apt update | soar sync |
| Install | sudo apt install <pkg> | soar install <pkg> |
| Remove | sudo apt remove <pkg> | soar remove <pkg> |
| Update | sudo apt upgrade | soar update |
| Search | apt search <query> | soar search <query> |
| List installed | apt list --installed | soar info |
From pacman (Arch Linux)
| Task | pacman Command | Soar Equivalent |
|---|---|---|
| Update database | sudo pacman -Sy | soar sync |
| Install | sudo pacman -S <pkg> | soar install <pkg> |
| Remove | sudo pacman -R <pkg> | soar remove <pkg> |
| Update system | sudo pacman -Syu | soar update |
| Search | pacman -Ss <query> | soar search <query> |
| List installed | pacman -Qe | soar info |
Managing Multiple Systems
Profiles let you maintain separate package environments.
Create a Profile
Edit ~/.config/soar/config.toml:
[profile.default]
root_path = "~/.local/share/soar"
[profile.dev]
root_path = "~/dev-tools"
Use Profiles
soar --profile dev install neovim
soar --profile dev list
soar --profile dev update
Set Default Profile
default_profile = "dev"
Troubleshooting
Having issues? Run diagnostics:
soar health
For comprehensive troubleshooting, see Health & Diagnostics.
What’s Next?
- Configuration - Customize settings and repositories
- Package Management - Install, update, and manage packages
- Profiles - Set up installation profiles