Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions PROJECT_STATUS.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
"One running local server remains bound to one repository; the repository control documents how to start recall serve elsewhere rather than claiming hot switching",
"Dependency-free routed shell; no production frontend framework",
"Uses the loopback Control API only and does not read storage directly",
"OAF-024 views are read-only and do not add approval mutation endpoints",
"Memory evidence views keep reads separate from confirm-gated proposal approval through the authenticated loopback API; they do not add write-capable MCP tools or external writes",
"Fabric Map is a read-only visualization over existing local dashboard state; it does not add telemetry, model calls, external adapters, or external writes"
]
},
Expand Down Expand Up @@ -785,8 +785,8 @@
"docs/release/1.0-RELEASE-CHECKLIST.md"
],
"limitations": [
"Release-candidate readiness evidence is merged to main; npm metadata is publish-ready, but product 1.0 is not published",
"Final merge, tag creation, artifact signing, and product release publication require explicit maintainer approval",
"memory-recall 1.0.5 is published; the 1.1.0 source release candidate on main is not yet published to npm",
"Publishing, tagging, or signing the 1.1.0 release candidate requires explicit maintainer approval",
"No signing keys, release credentials, hosted publishing automation, external writes, or external adapter activation are added"
]
},
Expand Down Expand Up @@ -1048,7 +1048,7 @@
"npm run consumer:smoke",
"npm run consumer:browser-smoke"
],
"testsExpected": 659,
"testsExpected": 660,
"protocolFixturesExpected": 182,
"evaluationsExpected": 144,
"note": "Counts are a dated snapshot; command results and HANDOFF_VERIFICATION.json are authoritative."
Expand Down
51 changes: 30 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,22 @@ Memory Recall turns a repository into a governed context source. New agent
sessions get reviewed repo facts, changed-file impact, required local reads,
and proof of what was sent instead of a giant pasted transcript.

The current source checkout is the 1.1.0 release candidate. npm still serves
1.0.5, which does not include Recall Map. Until 1.1.0 is published, run the
current quickstart from a source checkout:

```bash
npm install -g memory-recall
recall setup
recall map --root . --sqlite .local/memory.sqlite --format summary
recall handoff
git clone https://github.com/rebel0789/Memory-Recall.git
cd Memory-Recall
npm install
npm run recall -- setup
npm run recall -- map --root . --sqlite .local/memory.sqlite --format summary
Comment on lines +31 to +34

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep source quickstart in the target repository

When users try the 1.1.0 source candidate against their own repository, this sequence first changes into the Memory-Recall checkout and then runs setup; setupConsumerWorkspace() initializes process.cwd() and has no --root option, so .local is created in the tool's source repo and the following --root . map scans Memory-Recall instead of the target project. Please show an invocation that preserves the user's repo as cwd or installs the source checkout as a bin before running these commands.

Useful? React with 👍 / 👎.

npm run recall -- handoff
```

`recall setup` creates only local state. `recall map` is the explicit first
read-only repository scan; it does not run silently during setup.
read-only repository scan; it does not run silently during setup. After 1.1.0
is published, the global `recall` commands are the equivalent installed path.

Normal quickstarts use `recall`. The [developer-first product contract](docs/product/memory-recall-developer-first.md)
defines the `implemented`, `experimental`, and `unsupported` capability
Expand All @@ -52,28 +59,30 @@ for preserved legacy names and URIs.
## Five-Minute Path

```bash
# Install the CLI.
npm install -g memory-recall
# Install the current source release candidate.
git clone https://github.com/rebel0789/Memory-Recall.git
cd Memory-Recall
npm install

# Create local state only. This does not scan the repository.
recall setup
npm run recall -- setup

# Run the first explicit read-only repository map.
recall map --root . --sqlite .local/memory.sqlite --format summary
npm run recall -- map --root . --sqlite .local/memory.sqlite --format summary

# Run the handoff verification gate.
recall verify
npm run recall -- verify

# Preview local agent setup. This writes nothing.
recall connect codex --dry-run --format json
recall mcp install --client claude-code --dry-run --format json
npm run recall -- connect codex --dry-run --format json
npm run recall -- mcp install --client claude-code --dry-run --format json

# Build governed memory proposals. Facts are not trusted until reviewed.
recall memory ingest --root . --sqlite .local/memory.sqlite --format json
recall memory review --root . --sqlite .local/memory.sqlite --format summary
npm run recall -- memory ingest --root . --sqlite .local/memory.sqlite --format json
npm run recall -- memory review --root . --sqlite .local/memory.sqlite --format summary

# Produce the compact handoff for the next coding agent.
recall handoff
npm run recall -- handoff
```

The default path is local and explicit: no hosted account, no model API key, no
Expand All @@ -84,9 +93,9 @@ consented provider request to create pending proposals from selected
documentation. Start with the body-free plan:

```bash
recall semantic plan --harness codex --root . --dry-run
recall semantic task --harness codex --root .
recall semantic import --input semantic-result.json --root . --sqlite .local/memory.sqlite
npm run recall -- semantic plan --harness codex --root . --dry-run
npm run recall -- semantic task --harness codex --root .
npm run recall -- semantic import --input semantic-result.json --root . --sqlite .local/memory.sqlite
```

The CLI does not invoke the harness. Direct API execution requires a user-owned
Expand Down Expand Up @@ -243,12 +252,12 @@ boundaries.

## Status

Development kit: **1.0.5**.
Source release candidate: **1.1.0**. Published npm version: **1.0.5**.

| Surface | Status |
| --- | --- |
| Source checkout | Local-ready reference path |
| npm package | Published as `memory-recall` |
| Source checkout | 1.1.0 local-ready release candidate |
| npm package | 1.0.5 published; Recall Map quickstart awaits the 1.1.0 release |
| CLI | `recall` |
| Marketplace / plugin registry | Manifest prepared; not submitted |
| Client hooks | Opt-in Codex/Claude connect writer; dry-run/manual fallback |
Expand Down
37 changes: 21 additions & 16 deletions REPOSITORY_MANIFEST.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"schemaVersion": "1.0.0",
"project": "memory-recall",
"generatedAt": "2026-07-15T10:17:11.564Z",
"fileCount": 922,
"totalBytes": 6425642,
"generatedAt": "2026-07-15T11:16:55.792Z",
"fileCount": 923,
"totalBytes": 6428286,
"exclusions": [
".git/**",
".local/**",
Expand Down Expand Up @@ -450,10 +450,15 @@
"bytes": 566,
"sha256": "b4dd09cbbf368a7138af69fa727cff125161dede497c728783d15a3587659c17"
},
{
"path": "apps/cli/help.mjs",
"bytes": 25248,
"sha256": "0c0117d86106ec7e5f9cd65a3481ef92b06d5daf63fab94cb26517a9d7ac766d"
},
{
"path": "apps/cli/oaf.mjs",
"bytes": 484685,
"sha256": "8927c21f14affef6c6d12e701e234db4201b5292c00ef49632644489de02b2ad"
"bytes": 459579,
"sha256": "fa7200d942591e92ef954ac3879cf1d9556cf1aa907a52658066ad1002ea9a4b"
},
{
"path": "apps/web/AGENTS.md",
Expand Down Expand Up @@ -1088,12 +1093,12 @@
{
"path": "docs/release/1.0-PROVENANCE.json",
"bytes": 2414,
"sha256": "b784ca3507a140e11fa2d72e4b7f83ac98997ccbdfcb8c96b7888079b6645393"
"sha256": "fb281b9df61cd9cf0012eebec67a668dd74635666fd2ea623ff8d983359de1cc"
},
{
"path": "docs/release/1.0-READINESS-REPORT.md",
"bytes": 3391,
"sha256": "e4d95f4d9edc743526107b519a63db07955dc225c8e0d3f325261bc8e3919b9c"
"sha256": "5ed33403f42cfc4fa86ba01c06c797ca7d641ea1db80b26e8764c9d39e023df6"
},
{
"path": "docs/release/1.0-RELEASE-CHECKLIST.md",
Expand All @@ -1103,7 +1108,7 @@
{
"path": "docs/release/1.0-REPRODUCIBILITY.md",
"bytes": 1723,
"sha256": "488b7a0c79b1554135d42f9805f58d1af8915985b88af9a28e9774e14796b758"
"sha256": "b099296e900294decc60d6b48c5ad0ff4b6d1f6a2b34181c50499573b2ce4f2d"
},
{
"path": "docs/release/1.0-SBOM.json",
Expand Down Expand Up @@ -3442,8 +3447,8 @@
},
{
"path": "PROJECT_STATUS.json",
"bytes": 60779,
"sha256": "2da0461472309a658fac2798db0faba3e0895ce84e499d41022fe44b39b29318"
"bytes": 60855,
"sha256": "d69f9d5cd81b825dd4421b13a48e47090ed422a84fa10746a3f965291ba2d9f2"
},
{
"path": "providers/AGENTS.md",
Expand Down Expand Up @@ -3657,8 +3662,8 @@
},
{
"path": "README.md",
"bytes": 14006,
"sha256": "aea69b08f5576a4586e7dd7b3713a5744ec2b299bbda93b8928b81188cd1910b"
"bytes": 14677,
"sha256": "6290d03d15a62bd121fea8007824b5c14327a6e7ce4e20f45f0d11b6f584aa23"
},
{
"path": "REPOSITORY_MAP.md",
Expand Down Expand Up @@ -3752,8 +3757,8 @@
},
{
"path": "scripts/consumer-browser-smoke.mjs",
"bytes": 23703,
"sha256": "27c6584db7a5234a170387769b8aa7c6d8742e87836ba4c40c911cb9b96ff4d6"
"bytes": 24218,
"sha256": "dc17608ad6af8d0c1afd4670410b6611d68dfb2c47a85917954a23fc5955f6e9"
},
{
"path": "scripts/consumer-smoke.mjs",
Expand Down Expand Up @@ -4522,8 +4527,8 @@
},
{
"path": "tests/usage-docs.test.mjs",
"bytes": 16402,
"sha256": "ce39f08fdfeafcc92dab38e137fda17936a0fcbcaf96a179d96a4ab5f205ae07"
"bytes": 17642,
"sha256": "b48a48ba58941a19d4fcca4cc7a7a7cc2cce3ef53d743dc7d8b0cbf7e2b7ca70"
},
{
"path": "tests/web-shell.test.mjs",
Expand Down
Loading