Skip to main content

Maintenance CLI for the Claude Code / OpenClaw file-based memory system.

Project description

memory-doctor

Maintenance CLI for the Claude Code / OpenClaw file-based memory system. Five verbs:

memory-doctor status              # read-only summary
memory-doctor lint                # find dead [[wiki-links]]; exit 1 if any
memory-doctor ingest [--apply]    # promote pending handoffs into cards
memory-doctor compact [--apply]   # flatten multi-line MEMORY.md entries into topic files
memory-doctor init-git            # initialize the memory dir as a git repo (one-time)

ingest and compact default to dry-run; pass --apply to actually write.

Install

pipx install git+https://github.com/escoffier-labs/memory-doctor

Or from a local clone:

git clone https://github.com/escoffier-labs/memory-doctor && cd memory-doctor
pipx install .

Requires Python 3.10+. No runtime dependencies beyond stdlib.

Development

Install test dependencies and run the suite:

python3 -m pip install -e '.[dev]'
python3 -m pytest -q

The repo config points pytest at src/, so tests also run from a plain checkout without an editable install as long as pytest is available.

Configuration

What Flag Env Default
Memory dir (cards + MEMORY.md) --memory-dir PATH MEMORY_DOCTOR_MEMORY_DIR ~/.claude/projects/<project-scope>/memory
Handoffs dir --handoffs-dir PATH MEMORY_DOCTOR_HANDOFFS_DIR ~/.openclaw/workspace/.claude/memory-handoffs
MEMORY.md threshold (lines) --max-lines N MEMORY_DOCTOR_MAX_LINES 180
Commit verb output --commit / --no-commit MEMORY_DOCTOR_COMMIT off
Commit author override --commit-author "Name <e>" MEMORY_DOCTOR_COMMIT_AUTHOR from git config

<project-scope> is the dash-prefixed home-dir path Claude Code uses to scope per-project memory (e.g. -home-alice for user alice, -home-bob for user bob). The defaults are tuned for the OpenClaw layout. Override via flags or env for other setups.

What each verb does

status

Prints memory dir path, card count, MEMORY.md line+byte count, threshold status, dead-link count, handoffs dir path, pending + processed counts, oldest pending age. Exits 0. --json for a structured payload.

lint

Walks every .md in the memory dir, extracts [[wiki-link]] references, checks whether each target exists. Reports dead links grouped by source file with a closest-match suggestion (Levenshtein distance ≤ 3). Exits 0 if zero dead links, 1 if any (so you can gate a pre-commit hook on it).

ingest

Sweeps the handoffs dir for unprocessed *.md files matching the standard handoff template. For each one:

  • Recommended memory action: create-card writes a new card to the memory dir; skips on conflict (use --force to overwrite)
  • Recommended memory action: update-card appends the suggested content to an existing card; errors if the target is missing
  • Recommended memory action: no-card just moves the handoff to processed/

Successful handoffs are moved into <handoffs-dir>/processed/. Dry-run by default; --apply writes.

compact

Reads MEMORY.md, counts lines. If above the threshold, identifies multi-line entries (bullets whose detail spans more than one line) and proposes flattening them: keep the one-liner in the index, append the detail to the target topic file under a ## From index (YYYY-MM-DD) section. Dry-run by default; --apply writes (topic files first, MEMORY.md last). Refuses if a target topic file is missing (would orphan content). Warns if compaction alone won't bring MEMORY.md under threshold.

Commit integration (v0.2)

ingest --apply and compact --apply can be tied to a git commit in the memory dir so every write is reviewable and revertable.

# One-time setup: turn the memory dir into a git repo.
memory-doctor init-git

# Each --apply now produces one commit.
memory-doctor ingest --apply --commit
memory-doctor compact --apply --commit

Off by default; opt in via --commit or MEMORY_DOCTOR_COMMIT=1. --no-commit overrides the env var for a single run.

Pre-flight checks (any failure aborts the run, writes nothing):

  1. Memory dir is a git repo (otherwise: run memory-doctor init-git).
  2. No uncommitted local changes on the files this verb would touch (protects in-flight manual edits).
  3. Git is not in the middle of a merge, rebase, cherry-pick, or bisect.

Commit message shape:

memory-doctor ingest: 3 handoffs promoted

- cards/foo.md (create-card from 2026-05-22_foo.md)
- cards/bar.md (update-card append from 2026-05-22_bar.md)
- cards/baz.md (create-card from 2026-05-22_baz.md)

No Co-Authored-By or Generated with trailers; subject already identifies the tool.

--commit without --apply is a no-op and exits 0 (friendly for experimentation).

If git rejects the commit after writes succeed, for example because a hook fails, memory-doctor leaves the touched files staged and exits non-zero. Review the staged diff, fix the hook failure, then commit or unstage manually.

Examples

# Daily morning check:
memory-doctor status

# Drain the inbox:
memory-doctor ingest --apply

# Bring MEMORY.md back under threshold:
memory-doctor compact --apply

# Pre-push hook:
memory-doctor lint

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

memory_doctor-0.2.0.tar.gz (54.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

memory_doctor-0.2.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file memory_doctor-0.2.0.tar.gz.

File metadata

  • Download URL: memory_doctor-0.2.0.tar.gz
  • Upload date:
  • Size: 54.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for memory_doctor-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7c2e7f7438d68ad13e6fc3e1d337f38dee5e5c4c6dc0bb702acdc41d98dc09e3
MD5 a3022e62b8b3f9326d17d8866977cd78
BLAKE2b-256 91b522aa44196ec22eb9365750f6a867a9077d1ce8f4fc518df5b06ea54ec380

See more details on using hashes here.

File details

Details for the file memory_doctor-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: memory_doctor-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for memory_doctor-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f55d8238d24277da0bf00740ca4b3ad0e6bf669683d94e576f96536a8b75a9c
MD5 23eb1c68875cba15fa0840385d1c177a
BLAKE2b-256 cd3daeafed756216dba8c396ac0d94bd7cc981caeb3b08f3191ef4328cf3ed70

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page