Getting Started
OpenAgent has two installable client pieces plus an optional CLI. You only need the Agent Server — the CLI and Desktop App are optional clients.
Agent Server
The runtime. Install this on the machine where your agent should live.
macOS — double-click the .pkg. Linux / Windows — extract the archive. Or from a terminal:
curl -fsSL https://openagent.uno/install.sh | shStart it from any folder:
openagent serve ./my-agentThe folder becomes your agent — config, memory, and database live inside ./my-agent/.
First run: openagent serve automatically bootstraps a personal network. It prints an invite ticket (oa1...) — paste this into the desktop app or CLI client to connect. No separate setup step needed. See Invitation System & Networking for details on how the network works.
openagent serve --no-auto-init # Skip network bootstrap (standalone mode)Desktop App
A native chat window for your agent.
Launch the installer, then paste the invite ticket printed by openagent serve to connect. The desktop app handles the Iroh P2P transport and device certificate automatically — no manual config needed.
CLI Client
A terminal client for talking to a running server.
Extract the archive and connect using the invite ticket:
# First-time join (paste the oa1... ticket from the server)
openagent-cli connect oa1abc123...
# Returning user (saved credentials)
openagent-cli connect alice@homelabMulti-agent
Run multiple independent agents in parallel, each with its own data directory:
openagent serve ./agent-work
openagent serve ./agent-homeEach directory contains its own openagent.yaml, database, memories, and logs. Each gets its own Iroh identity and network configuration.
Service installation
Install OpenAgent as a system service that auto-starts on boot:
openagent service install # Default service
openagent service install ./my-agent # Per-agent service
openagent service status
openagent service uninstallSupports systemd (Linux), launchd (macOS), and Task Scheduler (Windows).