Skip to content

README: make command examples copy-pasteable from repo root #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VrilLabs merged 2 commits into from
Aug 16, 2026
Merged

README: make command examples copy-pasteable from repo root #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
910f3ea
Apply README script-path corrections
Copilot Aug 16, 2026
ae4fdb4
Fix inline env-var expansion in README checklist
Copilot Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 24 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Comment on lines +157 to +159
--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
```

Expand All @@ -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/<slug>.md --content-file "$TMP"
skills/memory-system/scripts/memory --cwd . index-link --scope user --slug <slug> --filename <slug>.md --summary "$ONE_LINE"
skills/memory-system/scripts/memory --cwd . read user/<slug>.md # re-read is proof
$MEMORY --cwd . write user/<slug>.md --content-file "$TMP"
$MEMORY --cwd . index-link --scope user --slug <slug> --filename <slug>.md --summary "$ONE_LINE"
$MEMORY --cwd . read user/<slug>.md # re-read is proof

# irreversible delete — confirm path must equal path
skills/memory-system/scripts/memory --cwd . forget user/<slug>.md --confirm user/<slug>.md
$MEMORY --cwd . forget user/<slug>.md --confirm user/<slug>.md

# ledger drift? rebuild from markdown
skills/memory-system/scripts/memory --cwd . reindex
$MEMORY --cwd . reindex
```

---
Expand Down Expand Up @@ -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.
Expand All @@ -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

---
Expand Down