Skip to content

Animus Documentation

What is Animus? A Mind-class AI exocortex — persistent memory, multi-agent orchestration, and autonomous improvement. Version: 2.3.0 (migrating to v2.1 baseline) · Tests: 16,178+ · License: MIT

Quickstart

New here? Start with one of these paths based on your goal:

If you want to... Go to
Install and run Animus Getting Started → Quickstart
Understand the system Architecture → Overview
Contribute code or docs Contributing → Setup
Deploy or operate Animus Operators → Deployment
Read about the v2.1 architecture Architecture → Decisions

Documentation Map

Getting Started

  • Quickstart — Install, configure, and run in under 10 minutes
  • Installation — Per-package install instructions
  • Concepts — Core mental models: exocortex, forge, quorum, kernel

Architecture

  • Overview — System context, four-layer stack, data flow
  • Packages — Dependency map and package responsibilities
  • Decisions — ADRs and decision logs (ADL)
  • Standards — Documentation, code quality, and commit conventions

Packages

Each package has its own documentation lane:

  • Core — Personal AI exocortex (import animus)
  • Forge — Multi-agent orchestration (import animus_forge)
  • Bootstrap — System daemon and onboarding (import animus_bootstrap)
  • Quorum — Agent coordination protocol (import convergent)
  • Kernel — Autonomous builder engine (standalone)
  • Types — Shared schema types
  • PWA — Progressive web app interface
  • Contracts — Canonical JSON schemas

Contributing

  • Setup — Dev environment, Python versions, local LLM
  • Guidelines — Code style, PR process, testing
  • Workflow — Git flow, CI expectations, release process
  • Debugging — Common issues and diagnostics

Operators

Reference

  • Glossary — Domain terms and definitions
  • FAQ — Frequently asked questions
  • Changelog — Release history
  • Security — Threat model, security layer, best practices
  • Whitepapers — Architecture whitepapers

Roadmap

  • Current — Active quarter priorities
  • Index — All roadmap documents

Repository Entry Points

File Purpose
Root README Project elevator pitch and badges
CLAUDE.md Session instructions for Claude Code
Project Charter v2.1 scope, success criteria, risks

Status

  • Build: Clean (0 warnings, 0 errors) — verified 2026-07-06
  • Deployment: Blocked — repo is private, so GitHub Pages requires Pro. Cloudflare Pages workflow is ready (.github/workflows/docs-deploy-cloudflare.yml); set CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID secrets to enable.
  • Reorganization: Active (see docs/planning/documentation-roadmap.md). If a link is broken or a section is missing, file an issue or submit a PR.