Skip to content

Commit 25651c0

Browse files
nickrociclaude
andcommitted
docs(readme): fix four pieces of drift from the rest of the README
- Quick start: replaced "Phase 4 work" (internal jargon) with "auto-supervision not yet implemented" — readers landing here shouldn't need to know our phase numbering. - "Where your memories live" table: added the ``cost.json`` row (was already in the deeper Storage-on-disk tree but missing from the user-facing quickstart summary). - Layout section: "177 pytest tests" → pointer to the Status section's current count, so this stops drifting every time we add tests. - Cost section: ambient priming overhead was listed as "~500 chars / ~150 tokens" with "BM25 + embeddings" pipeline. Updated to "~1500 chars / ~400 tokens" (matches the actual Tier-1 budget) and added the cross-encoder rerank to the pipeline description (matches the Tier-1 table and what PR #5 actually shipped). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 87cdc08 commit 25651c0

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ cd ../tools/search && uv sync
107107
# machine — it listens on ~/.agent-mem/priming.sock and answers Tier-1
108108
# priming requests from every hook on every project.
109109
cd /path/to/ultan/daemon && uv run agent-mem-daemon -v
110-
# (nohup, tmux, or a launchd plist if you want it persistent — Phase 4 work.)
110+
# (nohup, tmux, or a launchd plist if you want it persistent — auto-supervision
111+
# not yet implemented.)
111112

112113
# 5. Open Claude Code in any project (no per-project setup needed once the
113114
# hooks are global) and work normally. Entries land under
@@ -126,6 +127,7 @@ Everything Ultan owns lives under **`~/.agent-mem/`** on your local disk — no
126127
| `~/.agent-mem/.bm25.idx`, `.embeddings.idx` | Search indexes over the library. Rebuilt automatically when the library changes. |
127128
| `~/.agent-mem/sweep-state.json` | Last-decay-sweep timestamp (24h cooldown). |
128129
| `~/.agent-mem/pending-nudges.md` | Scholar writes nudges here; the hook reads and clears them on the next turn. |
130+
| `~/.agent-mem/cost.json` | Running tally of LLM spend across Librarian / Scholar / Advisor calls. |
129131
| `~/.agent-mem/runs/` | Per-call audit log (cost, duration, decisions) + full LLM transcripts (7-day TTL). |
130132

131133
See *Storage on disk* below for the full layout including the folders inside `knowledge/`.
@@ -234,7 +236,7 @@ agent-mem/
234236
README.md ← this file
235237
daemon/ ← the long-lived event-ingest daemon
236238
agent_mem_daemon/ ← package
237-
tests/ ← 177 pytest tests
239+
tests/ ← pytest suite (see Status below for current count)
238240
pyproject.toml ← uv-managed
239241
src/ ← Phase-0 hook layer (forked from claude-memory-compiler)
240242
hooks/ ← UserPromptSubmit, PostToolUse, Stop, ...
@@ -278,7 +280,7 @@ Storage on disk:
278280

279281
- **Librarian (Sonnet)** runs after each session's quiet period (per-session debounce, default 30s). With moderate activity that's ~10-30 invocations per working day per project. Each is a few thousand input tokens (prompt + library snapshot + buffer) plus a few hundred output tokens.
280282
- **Scholar (Opus)** runs in batches — every 3 Librarian packets or 60s, whichever first. Each batch is one Opus call: prompt + accumulated proposals, ~30s wall time, ~$0.20-0.50 per batch on pay-as-you-go pricing.
281-
- **Ambient priming (Tier 1)** is daemon-side BM25 + embeddings, **no LLM cost**, but it injects up to 500 chars into every UserPromptSubmit — call it ~150 tokens of prompt overhead per turn.
283+
- **Ambient priming (Tier 1)** is daemon-side BM25 + embeddings + cross-encoder rerank, **no LLM cost**, but it injects up to 1500 chars into every UserPromptSubmit — call it ~400 tokens of prompt overhead per turn.
282284
- **Advisor (`/ultan-advisor`)** is one Sonnet call (Librarian step) + one Opus call (Scholar synthesis) per invocation. ~$0.30-0.50 each.
283285
- **PreToolUse Tier 3** is pure deterministic regex match, **no LLM cost**, sub-100ms.
284286

0 commit comments

Comments
 (0)