Documentation

Condensed from the shipped bundle. Full detail lives in INSTALL.md inside your download.

Installation

Linux or macOS. Python 3.10+. A Hermes-compatible gateway (bundled with your download).

./installer/preflight.sh
./installer/install.sh

Then open http://127.0.0.1:3001 (default) and complete the wizard.

How updates work

ANIMUS reads ANIMUS_UPDATE_URL from animus.env (see animus.env.example). On launch it fetches JSON with version, download_url, and notes. When a newer version exists, you get a banner; one click downloads the zip and extracts over the install (then restart).

Version history for this site: Updates.

Publishing new versions (sellers)

If you operate the update manifest for ANIMUS, use the seller publish page (upload zip + refresh manifest) or the CLI flow in the ANIMUS repo README. Buyers do not need this page — they use in-app updates or re-download from Gumroad.

Tailscale & mobile

Run ANIMUS bound to 127.0.0.1, use Tailscale Serve to expose HTTPS to your tailnet, and set HERMES_CHAT_PUBLIC_URL / wizard hints to match. Install the PWA from your phone’s browser for a home-screen icon.

FAQ

See the homepage FAQ for common questions.