Documentation

Start with the agent-facing path

01 / STARTInstall and initialize

Install one binary, initialize a project, and inspect the ambient context your agent will inherit.

02 / RECALLRecall claims with references

Ask whether Memoree has something and receive claims, exact evidence revisions, byte spans, and open conflicts.

03 / CONTEXTGive an agent bounded context

Build a citation-rich packet within a byte budget while keeping retrieved content explicitly untrusted.

04 / PRESERVEPreserve a deliberate checkpoint

Stage a small handoff note outside recall, then review and promote it through the normal grounding boundary.

The shortest useful workflow

cd /path/to/project
memoree init --name my-project
memoree recall "what do we know about the deployment decision?"
memoree context build "deployment constraints" --max-bytes 4096
memoree remember --apply "Production deploys require a clean migration check."

Normal retrieval stays within ambient project/task context. A none result is honest absence at that horizon, not permission to widen the search. Broaden to workspace or personal scope only for a separate request with a reason.

Understand the boundaries

• Architecture explains local storage, immutable revisions, scope, and why indexes remain disposable.
• Context and configuration defines markers, task-local sessions, personal fallback, and application paths.
• Quality gates records the claims the project is willing to make and the evidence required before making stronger ones.
• Retrieval evaluation separates deterministic correctness checks from downstream model quality.