diff --git a/README.md b/README.md index 5d9c40a..6ef6b5f 100644 --- a/README.md +++ b/README.md @@ -148,19 +148,23 @@ memory-system/ ## Quick start +Set the path to the memory tool once. From this repo root use `skills/memory-system/scripts/memory`; after installing the skill use your installed path (e.g. `.agents/skills/memory-system/scripts/memory`). + ```bash +MEMORY=skills/memory-system/scripts/memory # change if installed elsewhere + # from a real project root (or pass --cwd / --root) -skills/memory-system/scripts/memory --cwd . init +$MEMORY --cwd . init -skills/memory-system/scripts/memory --cwd . write user/edge-tls.md \ +$MEMORY --cwd . write user/edge-tls.md \ --content "# Edge TLS Terminate TLS at Envoy. " -skills/memory-system/scripts/memory --cwd . search "Envoy TLS" +$MEMORY --cwd . search "Envoy TLS" -skills/memory-system/scripts/memory selftest +$MEMORY selftest # → "ok": true, exit 0 ``` @@ -169,23 +173,25 @@ The agent loads the skill when you say *remember*, *forget*, *persist a preferen ### Typical agent workflow ```bash -skills/memory-system/scripts/memory --cwd . root -skills/memory-system/scripts/memory --cwd . glob "user/**/*.md" -skills/memory-system/scripts/memory --cwd . read user/MEMORY.md -skills/memory-system/scripts/memory --cwd . search "edge proxy" +MEMORY=skills/memory-system/scripts/memory # change if installed elsewhere + +$MEMORY --cwd . root +$MEMORY --cwd . glob "user/**/*.md" +$MEMORY --cwd . read user/MEMORY.md +$MEMORY --cwd . search "edge proxy" -skills/memory-system/scripts/memory classify --text "$PAYLOAD" --hint "$INTENT" --title "$TITLE" -skills/memory-system/scripts/memory slug "$TITLE" +$MEMORY classify --text "$PAYLOAD" --hint "$INTENT" --title "$TITLE" +$MEMORY slug "$TITLE" -skills/memory-system/scripts/memory --cwd . write user/.md --content-file "$TMP" -skills/memory-system/scripts/memory --cwd . index-link --scope user --slug --filename .md --summary "$ONE_LINE" -skills/memory-system/scripts/memory --cwd . read user/.md # re-read is proof +$MEMORY --cwd . write user/.md --content-file "$TMP" +$MEMORY --cwd . index-link --scope user --slug --filename .md --summary "$ONE_LINE" +$MEMORY --cwd . read user/.md # re-read is proof # irreversible delete — confirm path must equal path -skills/memory-system/scripts/memory --cwd . forget user/.md --confirm user/.md +$MEMORY --cwd . forget user/.md --confirm user/.md # ledger drift? rebuild from markdown -skills/memory-system/scripts/memory --cwd . reindex +$MEMORY --cwd . reindex ``` --- @@ -264,7 +270,8 @@ Development guidance and the SQLite stack rationale live in [`AGENTS.md`](AGENTS ## Verify ```bash -skills/memory-system/scripts/memory selftest +MEMORY=skills/memory-system/scripts/memory # change if installed elsewhere +$MEMORY selftest ``` Must print `"ok": true` and exit `0`. The suite asserts journal mode, single-file DB (no `-wal`/`-shm`), FTS search, dual-write checksums, secret rejection, and forget purge semantics. @@ -287,7 +294,7 @@ Must print `"ok": true` and exit `0`. The suite asserts journal mode, single-fil 1. Keep Zone B (`references/memory_tool`) deterministic — do not reformat or second-guess its JSON 2. Markdown remains the only source of truth for prose -3. Run `skills/memory-system/scripts/memory selftest` before proposing changes that touch the tool or ledger +3. Run `MEMORY=skills/memory-system/scripts/memory; $MEMORY selftest` before proposing changes that touch the tool or ledger 4. Do not ship user rows, pre-filled DB binaries, WAL mode, or GUI/admin sidecars ---