Docs
GitHubBlog

Search Documentation

Search for a page in the docs

Installation Overview

Pick the path that matches what you are trying to do.

I want to...Start hereNotes
Try the desktop app on Apple Silicon or IntelmacOSSigned architecture-specific packages; still beta.
Run OpenAlice on WindowsWindowsThe unsigned desktop installer is self-contained; source remains the best-supported troubleshooting path.
Develop, debug, or contributeSource & DevBest logs, fastest fixes, and explicit control over the checkout.
Run a source checkout through a small local CLICLI & Remote AccessStable installer with managed Pi and Guardian-owned Server lifecycle.
Keep Alice in a container on a serverDockerImage, healthcheck, bundled Agent CLIs, and persistent volume.
Keep the browser local while Alice runs on an existing private hostCLI & Remote AccessManaged clone/update, Server lifecycle, and SSH loopback tunnel.

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 .dmg for 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 .exe if 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.
  • Existing private remote host: use the stable CLI and openalice remote; no manual checkout path is required, and the read-only plan names every bootstrap action before consent.
  • Container operator: use Docker Compose, then put access behind LAN, Tailscale, or a reverse proxy. Docker and managed SSH are parallel first-class server paths with different ownership models.

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:

  1. Open Quick Start.
  2. Ask Alice for a research task.
  3. Track an entity.
  4. Create or schedule an issue.
  5. 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.
  • CLI & Remote Access - Start a local source Runtime or connect to a private SSH host.