DOCUMENTATION · v0.4.2.14
Read the source truth.
Every page below is rendered from the product's own documents at v0.4.2.14. The documentation is versioned with the code, so what you read is what actually shipped.
Start here
- Install & first missionWindows quick start, Linux quick start, LXC, Docker
- What is free, and what is a subscriptionThe app is free. FORAGER and MICROMOUND are subscriptions. Here is where the line is
- Ant execution frameworkCOLONY: the twelve roles, runtime classification, execution gates
- Approval lifecycleOne approval queue, one lifecycle — nothing applies itself
- What FORAGER isFORAGER: files in, knowledge out, every statement traceable to its source
- What MICROMOUND isMICROMOUND: your own hardware, with limits you set
- PLAN — measured current stateWhere the colony measurably is, gap by gap
- Deployment guideProxmox, systemd, Docker, and Windows-service operations
How these docs work
Formicaria is one application built from three engines, and they live in one repository: COLONY, the assistants, in modules/anthill, FORAGER in modules/forager, and MICROMOUND in runtimes/micromound. Each engine keeps its documentation beside the code it describes, and the two are versioned together. This site republishes a curated set of those documents on every release — the install guides, the architecture contracts, the measured project state, the operations guides, and every architecture decision record. Each page names the file it was rendered from, as a path from the repository root, and the release it was rendered at. The README and the changelog also ship inside every download, so an installed colony carries its own install guide and release history.
The sections below follow the product. COLONY comes with the free app; FORAGER and MICROMOUND are subscription modules, and What is free, and what is a subscription says exactly where that line is.
START HERE
Install Formicaria, run a first mission, and see what is in the box.
COLONY — THE ASSISTANTS
The orchestration engine. Included in the free app. Source: modules/anthill.
- Ant execution frameworkRendered from
modules/anthill/docs/ANT_EXECUTION.md - Approval lifecycleRendered from
modules/anthill/docs/APPROVALS.md - Task contractsRendered from
modules/anthill/docs/CONTRACTS.md - Autonomy & stop controlsRendered from
modules/anthill/docs/AUTONOMY.md - Infrastructure integrationRendered from
modules/anthill/docs/INFRASTRUCTURE.md - The module contractRendered from
modules/anthill/docs/MODULE_CONTRACT.md - Mission Replay (settings only)Rendered from
modules/anthill/docs/MISSION_REPLAY.md
FORAGER — KNOWLEDGE
Turns your files into knowledge the colony can cite. A subscription module. Source: modules/forager, and the colony's side of the boundary in modules/anthill.
- What FORAGER isRendered from
modules/forager/README.md - How COLONY and FORAGER divide the workRendered from
modules/anthill/docs/FORAGER_INTEGRATION.md - Knowledge architectureRendered from
modules/anthill/docs/KNOWLEDGE_ARCHITECTURE.md - Retrieval: evidence firstRendered from
modules/anthill/docs/RAG.md - Knowledge APIRendered from
modules/anthill/docs/KNOWLEDGE_API.md - Knowledge securityRendered from
modules/anthill/docs/KNOWLEDGE_SECURITY.md
MICROMOUND — DEVICES
The runtime for your own hardware, driven by COLONY. A subscription module. Source: runtimes/micromound.
- What MICROMOUND isRendered from
runtimes/micromound/docs/MICROMOUND.md - Safety and physical authorityRendered from
runtimes/micromound/docs/SAFETY.md - Device capabilitiesRendered from
runtimes/micromound/docs/CAPABILITIES.md - Device configurationRendered from
runtimes/micromound/docs/CONFIGURATION.md - Deploying a moundRendered from
runtimes/micromound/docs/DEPLOY.md
STATE & ROADMAP
Where the product measurably is, and what comes next.
OPERATIONS
Running it for real: servers, services, containers.
DECISIONS
The architecture decision records, in the order they were made.
- ADR-001 Runtime compositionRendered from
modules/anthill/docs/adr/ADR-001-runtime-composition.md - ADR-002 Mission contextRendered from
modules/anthill/docs/adr/ADR-002-mission-context.md - ADR-003 Worker protocolRendered from
modules/anthill/docs/adr/ADR-003-worker-protocol.md - ADR-004 Artifact storeRendered from
modules/anthill/docs/adr/ADR-004-artifact-store.md - ADR-005 Workspace managerRendered from
modules/anthill/docs/adr/ADR-005-workspace-manager.md - ADR-006 Agent harnessRendered from
modules/anthill/docs/adr/ADR-006-agent-harness.md - ADR-007 Module boundaryRendered from
modules/anthill/docs/adr/ADR-007-module-boundary.md - ADR-008 Universal mission lifecycleRendered from
modules/anthill/docs/adr/ADR-008-universal-mission-lifecycle.md - ADR-009 Device tenancy and the controller keyRendered from
modules/anthill/docs/adr/ADR-009-device-tenancy-and-controller-key.md
