Getting started
This tour walks the main surfaces once. Each step links to a detailed guide.
1. Install the CLI
Section titled “1. Install the CLI”git clone https://github.com/sanudatta11/statefulmemory && cd statefulmemorymake prereqs && make installexport PATH="$HOME/.local/bin:$PATH"statefulmemory --versionFull notes: Install. Deployment modes (self-host vs StatefulMemory Cloud): Self-hosting and Cloud.
2. Wire your agent (and optional git hooks)
Section titled “2. Wire your agent (and optional git hooks)”statefulmemory install # MCP + skills; verify hooks if cwd is a repostatefulmemory install --no-git-hooks # skip hooksDetails: Wire into your agent.
3. Save an observation
Section titled “3. Save an observation”statefulmemory obs save \ --type decision \ --title "use pgx not GORM" \ --content "Team prefers raw SQL via pgx" \ --session "$(uuidgen)"Guide: Observations.
4. Search and pull context
Section titled “4. Search and pull context”statefulmemory obs search "pgx"statefulmemory obs context --query "deploy" --limit 20statefulmemory obs context --query "deploy" --max-tokens 500Guide: Search and context.
5. Anchor important claims
Section titled “5. Anchor important claims”statefulmemory obs save \ --type decision \ --title "login uses JWT" \ --content "Accept only HS256 in production" \ --anchor src/auth.rs::login \ --session "$(uuidgen)"
statefulmemory verifyGuide: Anchors and verify.
6. Decide when notes conflict
Section titled “6. Decide when notes conflict”statefulmemory decide "Should we keep SQLite or move to Postgres?"Needs an agent CLI (STATEFULMEMORY_LLM_*). Guide: Decide.
7. Back up
Section titled “7. Back up”statefulmemory mem export --out backup.memGuide: Mem archives.
Data lives under ~/.statefulmemory/. The daemon auto-starts on first use.
- Config — hybrid, verify, token budget, env overrides
- LoCoMo eval — smoke, full, staleness
- Troubleshooting
- Command cheat sheet