Documentation

Docs

Everything to evaluate, install, and operate Heartwood Memory. A full hosted docs portal is on the way — for now, deep references live in the repository.

Quickstart

Install and run

Pick a surface and go. The core is source-available and self-hosted — your data never leaves your environment.

On 0.1.0? Upgrade to 0.1.1 — it fixes a memory leak in the warm recall service (serve-recall) that could grow resident memory unbounded under sustained load. pip install -U "heartwood-memory[recall,mcp]"

The embedded library. Remember and recall in a few lines, governed by default.

pip
python -m pip install "heartwood-memory[recall,mcp]"

from heartwood import Heartwood

hw = Heartwood(path="./heartwood.db", tenant="tenant:acme")
hw.remember(
    "Refunds over $500 require finance approval.",
    subject="policy:refunds",
    created_by="agent:support",
)
results = hw.recall("what is the refund policy?", principal_id="agent:support")