Installation Overview
Pick the path that matches what you are trying to do.
| I want to... | Start here | Notes |
|---|---|---|
| Try the desktop app on Apple Silicon or Intel | macOS | Signed architecture-specific packages; still beta. |
| Run OpenAlice on Windows | Windows | The unsigned desktop installer is self-contained; source remains the best-supported troubleshooting path. |
| Develop, debug, or contribute | Source & Dev | Best logs, fastest fixes, closest to main. |
| Keep Alice running on a server | Docker | One long-lived Compose service with persistent data. |
| Reach Alice from another device | Remote Access | Prefer localhost, LAN, or Tailscale before public internet. |
OpenAlice does not need a database. State is file-backed: config, sessions, trading history, news, issues, inbox entries, workspace artifacts, and provider settings live under ~/.openalice by default. Docker uses a persistent volume for the same role. See Data & Credentials when you need the exact layout, admin token recovery, sealed broker credentials, or port configuration.
Recommended path
For daily dogfooding today:
- Mac user who wants the shortest path: use the signed
.dmgfor Apple Silicon or Intel; it includes managed Pi, so add an AI credential and start a Workspace without installing a separate agent CLI. - Windows user: use the self-contained
.exeif you accept an unsigned beta installer, or run from source for the clearest logs and debugging path. - Contributor or debugging user: run from source with
pnpm dev. - Server user: use Docker Compose, then put access behind LAN, Tailscale, or a reverse proxy.
The packaged desktop builds include their own Workspace runtime: Electron's
Node, managed Pi, and pinned fd/ripgrep, with PortableGit and Bash added on Windows. They still
need a model credential, either an API key configured in Settings → AI
Provider or a user-installed agent CLI with its own login. If something
breaks and you want visibility, the source path is the easiest way to see logs,
patch locally, and report a useful bug.
First thing after install
Once OpenAlice opens, do the core loop before connecting broker accounts:
- Open Quick Start.
- Ask Alice for a research task.
- Track an entity.
- Create or schedule an issue.
- Read the result in Inbox.
Broker execution is optional beta infrastructure. Use simulator, paper, demo, or testnet accounts first; read What is UTA before connecting live funds.
Next Steps
- macOS - Install the signed desktop build.
- Windows - Choose the self-contained beta installer or the source path.
- Source & Dev - Clone, run, debug, test, and build.
- Docker - Run a long-lived server instance.
- Remote Access - Reach Alice from another device safely.