Installation

Install Orpheus daemon and CLI

System Requirements

• macOS: 12.0+ (Apple Silicon or Intel)
• Linux: Ubuntu 20.04+, Debian 11+, or any systemd-based distro
• Memory: 2GB+ recommended
• Disk: 5GB for runtime images

Install the Daemon

macOS

1. Start Lima VM

   Orpheus runs in a Lima VM on macOS for Linux compatibility:

   orpheus vm start
   

   This downloads and starts the Orpheus VM (~5 minutes first time).

2. Verify Running

   orpheus status
   

   Should show: ✓ healthy

Linux

1. Download Binary

   # Download latest release
   wget https://github.com/orpheus-systems/orpheus/releases/latest/download/orpheusd-linux-amd64
   chmod +x orpheusd-linux-amd64
   sudo mv orpheusd-linux-amd64 /usr/local/bin/orpheusd
   
2. Start Daemon

   # Via systemd (recommended)
   sudo systemctl enable orpheusd
   sudo systemctl start orpheusd
   
   # Or run directly
   orpheusd start
   
3. Verify Running

   orpheus status
   

From Source

1. Clone Repository

   git clone https://github.com/orpheus-systems/orpheus.git
   cd orpheus
   
2. Build Daemon

   Requires Go 1.20+:

   make build
   

   Output: bin/orpheusd

3. Start Daemon

   ./bin/orpheusd start
   

Install the CLI

The Orpheus CLI lets you deploy and manage agents:

npm install -g @orpheus/cli

Verify installation:

orpheus --version

Verify Installation

Run the healthcheck command:

orpheus healthcheck

Expected output:

✓ Daemon running
✓ Worker pools healthy
✓ Storage accessible

Next Steps

Deploy Your First Agent

Follow the quick start guide →

Troubleshooting

Daemon won't start

Check if port 7777 is in use:

lsof -i :7777

Kill conflicting process or change port in config.

Permission denied

On Linux, you may need sudo:

sudo orpheusd start

Or add your user to the orpheus group.

VM won't start on macOS

Install Lima first:

brew install lima

Then retry orpheus vm start.