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

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.

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.

MICROMOUND — DEVICES

The runtime for your own hardware, driven by COLONY. A subscription module. Source: runtimes/micromound.

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.