Skip to content

docs: describe Lore as a local session archive and agent memory - #24

Merged
hsusul merged 1 commit into
mainfrom
p1-4-docs
Oct 26, 2026
Merged

hsusul merged 1 commit into
mainfrom
p1-4-docs

Conversation

@hsusul

@hsusul hsusul commented Oct 26, 2026

Copy link
Copy Markdown
Owner

Why

The README still described the agent orchestrator that #18 removed. Lore is now a local archive of Claude Code and Codex sessions, with a desktop app, lorectl, and lorectl mcp. The docs should say that, and say what is built and what is only planned.

What changed

  • README.md is rewritten. It covers what Lore is, how the scan, the redacted search index, and the git evidence work, the desktop app's flows and keyboard shortcuts, every lorectl command, and how to connect lorectl mcp to Claude Code with claude mcp add lore -- <path-to-lorectl> mcp.
  • It explains npm run dev with sample data and scripts/synth-archive.sh for a fake archive. It shows the env vars (CLAUDE_CONFIG_DIR, CODEX_HOME, LORE_ARCHIVE_DIR, and the debug-only LORE_DEV_CLAUDE_ROOT and LORE_DEV_CODEX_ROOT) and says never to point a development run at real history.
  • The development commands are the set .github/workflows/ci.yml runs on a pull request.
  • Status says Lore is early, has no signed build, and that memory features are planned, not built.
  • src-tauri/tauri.conf.json gets a new bundle.shortDescription and a bundle.longDescription.

Scope

  • Only README.md and the two description fields in src-tauri/tauri.conf.json.
  • .github/workflows/ci.yml is unchanged. No orchestrator-only step remains in it.
  • No screenshots and no visual styling, because the UI look is being redesigned.

Two README statements differ from the brief, on purpose.

  • The brief says "unreleased". GitHub has releases v0.1.0 and v0.1.1, unsigned macOS .dmg builds from August. The README says the newest release predates the current app and is unsigned.
  • The README says the desktop app needs at least one search word, so a filters-only query works in lorectl search and lorectl mcp (feat(search): answer filter-only queries and match repo: by name #22) but not yet in the app. The app's fetchSearch returns nothing when a query has no terms, and the empty state reads "Filters narrow a search. Add a word to search for."

Verification

Run in this worktree at head d06c971, after the tauri.conf.json edit.

  • grep -niE "orchestrat|worktree|merge queue|hand ?off|parallel" README.md prints one line, the worktree: search filter in the filter table. That is intentional. There are no em dashes and none of "seamless", "powerful", or "blazing".
  • Every relative link and image in the README resolves to a file that exists (LICENSE, assets/brand/lore-mark-light.svg, assets/brand/lore-mark-dark.svg).
  • Every command in the README's CI block passes: toolchain-pin-check.sh, cargo fmt --all -- --check, clippy for lore-core, lore-ipc, lorectl, cargo test --locked for the same three (--all-targets), both network-boundary tests, ./scripts/egress-check.sh (34 test binaries ran with the network denied), cargo test -p lore-ipc, git diff --exit-code crates/lore-ipc/bindings, npm ci, npm run lint, npm run typecheck, npm test (73 tests), npm run build, cargo clippy -p lore-app --all-targets -- -D warnings, cargo build --locked -p lore-app, and cargo test -p lore-app --test no_egress.
  • cargo build --release -p lorectl and target/release/lorectl --help work.
  • scripts/synth-archive.sh /tmp/p14 10 5 1 printed claude 10 codex 5. lorectl scan with CLAUDE_CONFIG_DIR, CODEX_HOME, and --archive /tmp/p14-arch reported ingested 15 skipped 0 failed 0. A second scan reported ingested 0. lorectl search, inspect, status, and mcp --help ran against it, and lorectl mcp answered initialize and search_sessions over stdio.
  • The README's own examples ran against scripts/synth-archive.sh /tmp/lore-fake 30 20 7 with LORE_ARCHIVE_DIR=/tmp/lore-fake-archive. That covers scan (50 ingested), search health, search "retry agent:codex", search agent:codex, inspect <id> --patch, and read_session over MCP.
  • npm run dev served the sample archive in the browser pane, with 122 sessions. / focused the query line. Typing a word, then Down, j, and Enter opened a session and focused the reader. Esc returned to the list. Cmd+K opened the palette. Cmd+,, the tab arrow keys, PageUp/PageDown, and Home/End were read in the source and not pressed.
  • claude mcp add --help documents the -- <command> <args> form for a stdio server.
  • The real ~/.claude, ~/.codex, and default archive were not used. Every scan used the fake homes and a scratch archive.

Not run.

  • npm run tauri dev opens a desktop window. I did not launch it. The README's three env vars for it are read from src-tauri/src/state.rs (app_config, debug builds only), and the shell builds.
  • claude mcp add lore -- <path> mcp was not executed, because it would change the user's Claude Code settings.
  • The weekly scale job and the Linux and macOS CI matrix were not run.

Rewrite the README for the archive app, lorectl, and lorectl mcp. Update the bundle descriptions in tauri.conf.json to match.
@hsusul
hsusul merged commit 067ef8d into main Oct 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant