![\"npm](\"https://img.shields.io/npm/v/openlore?color=2563eb&label=npm&logo=npm&logoColor=white\")
\n ![\"CI](\"https://github.com/clay-good/OpenLore/actions/workflows/ci.yml/badge.svg\"){kind=icon}
\n ![\"MIT](\"https://img.shields.io/npm/l/openlore?color=22c55e\")
\n ![\"Node](\"https://img.shields.io/node/v/openlore?color=339933&logo=node.js&logoColor=white\")
=22.22\">\n \n
![\"MCP](\"https://img.shields.io/badge/MCP-ready-7c3aed?logo=anthropic&logoColor=white\"){kind=icon}
\n ![\"21](\"https://img.shields.io/badge/languages-21%20%2B%2013%20IaC-f97316\"){kind=icon}
\n ![\"5500+](\"https://img.shields.io/badge/tests-5500%2B-success\"){kind=icon}
\n ![\"No](\"https://img.shields.io/badge/API_key-not_required-0ea5e9\"){kind=icon}
\n ![\"GitHub](\"https://img.shields.io/github/stars/clay-good/OpenLore?style=social\")
\n\n Deterministic, local-first memory and guardrails for AI coding agents — no LLM in the hot path.
\n Install once. From then on it runs in the background, keeping your agent oriented and its changes safe.
\n No API key. Same answer every time.\n
\n \n
\n
\n install wires your agent and indexes the repo → orient returns the code a task touches → review catches the change that breaks a contract. All local, no API key.\n
\n Install · What you get · Benchmarks · vs. Alternatives · Docs\n
\n\n---\n\nAI coding agents are **amnesiac and ungoverned**. Every task restarts by re-reading the same files, long sessions drift onto stale assumptions, and nothing warns the agent when a change is about to break a contract or cross a boundary.\n\nOpenLore fixes both halves, and then gets out of your way. A **one-time static analysis** builds a live knowledge graph of your repo — call structure, types, tests, decisions, IaC. From then on your agent is **already oriented at the start of every task** and its changes are **certified before they land** — automatically, deterministically, with **no LLM in the hot path**, so the same question returns the same grounded answer and the agent is *told when a fact goes stale* instead of served a confident guess.\n\n## Install once, then forget it\n\n```bash\nnpm install -g openlore && openlore install\n```\n\nThat is the only command most people ever run. It **auto-detects your agent** (Claude Code, Cursor, Cline, Continue, Pi, AGENTS.md), wires it, registers the MCP server, and builds the index — no API key, no config, no prompts. After that, **it's on in the background and you don't think about it:**\n\n- 🔄 **Every task starts oriented, automatically** — a compact architecture digest is injected into your agent's context at the start of each session, and your agent calls `orient()` and the other tools itself over MCP. You don't type anything.\n- 🌱 **Every repo, not just this one** — `install` wires your user account too, so each new git repo you open indexes itself in the background on first touch. \"Install once\" is literal.\n- 🩹 **Always fresh** — a file watcher re-indexes as you edit and converges to a full analysis; anything it can't recompute in time is marked explicitly stale, never silently wrong.\n- 🛡️ **Changes get checked before they land** — the governance tools (and `openlore review` on a PR) run deterministically with no API key.\n\nThe CLI below exists for humans and CI — `prove`, `review`, `doctor`, `features`. The everyday path is: install, then let your agent use it.\n\n> **Zero config.** Run **`openlore features`** to see every opt-in capability (embeddings, the commit gate, the spec store…), whether it's on, and the one command to enable it. `openlore doctor` verifies the wiring.\n\n---\n\n## What you get\n\nTwo things, both deterministic and local:\n\n**🧠 Memory — your agent starts every task already oriented**\n\n- **Orient in one call** — `orient(task)` returns the relevant functions, callers, specs, tests, and insertion points (**~430µs p50** on a 15k-node graph) instead of a dozen exploratory file reads.\n- **Survives refactors** — anchored notes and decisions carry forward when a symbol is renamed or moved, instead of orphaning.\n- **One graph for everything** — application code, Infrastructure-as-Code, and architectural decisions share one graph, so a single query spans all three.\n- **Told when a fact is stale** — every response carries a brief, **factual freshness note** (the Epistemic Lease) once a cached fact has aged or the repo moved, so a long session can't drift onto a confident guess.\n\n**🛡️ Governance — guardrails on what the agent changes**\n\n- **Breaking-change verdict** — `certify_public_surface` classifies every changed export `breaking / non-breaking / potentially-breaking` and **names the consumers each break hits**. Never silently \"safe.\"\n- **Sensitive-boundary check** — `change_impact_certificate` flags when a diff **opens a new path into a boundary you declared** (reachable after the change, not before).\n- **Grounded claims** — `verify_claim` returns `confirmed / refuted / unverifiable` with a citation, before an agent asserts \"X is dead\" or \"Y is safe to change.\"\n- **One commit gate** — `openlore enforce` blocks on findings you mark `blocking`. Advisory by default, no API key.\n\n**The one line to remember:** an agent's expensive failure mode isn't ignorance — it's *confidence*. A model that doesn't know a function exists will go look. A model that \"knows\" a stale fact builds on it, and you pay at review time. OpenLore is built so the agent can be told *\"that fact is stale\"* and *\"this change opens a path you said was sensitive\"* — deterministically, with no second model guessing about the first.\n\n---\n\n## Value Scorecard — does it pay for itself?\n\nOpenLore only earns its place if an agent **with** it reaches a correct answer for less total cost than the same agent **without** it. We measure that and publish it — wins **and** losses. Numbers from the Spec 14 benchmark (`claude -p`, sonnet, N=4 medians, pinned SHAs), measured **2026-06-01**.\n\n| Scenario | Cost Δ | Round-trips Δ | Verdict |\n|---|---|---|---|\n| **Large/unfamiliar repo · deep \"how does X flow through Y\"** *(its target)* | **−7% to −21%** | **−26%** | ✅ helps — and the win grows with repo size |\n| Small/familiar repo · shallow \"who calls X\" | task-dependent *(Round 1: +43%)* | +38% | ❌ often **adds overhead** — measure first |\n\nThe win scales with codebase size (round-trips without → with):\n\n| Repo (size) | Cost Δ | Round-trips |\n|---|---|---|\n| excalidraw (~640 files) | **−21%** | 25 → 16 |\n| tokio (~790 files) | **−21%** | 17 → 13 |\n| okhttp | **−13%** | 13 → 11 |\n| django (~3k files) | **−7%** | 21 → 15 |\n| gin (110 files, smallest) | +4% *(≈even)* | 10 → 9 |\n\n> **Re-confirmed live 2026-06-03:** the deep-task win reproduces (okhttp **−13%**); the small/familiar case is task-dependent, not a flat loss (chalk **−32%** win vs. express **+59%** loss). Don't guess from our repos — run **`openlore prove --estimate`** on yours (seconds, no API key).\n\n> **Honesty contract.** We never publish a savings number the benchmark didn't produce, we always show the losses next to the wins, and every claim traces to a command you can run. Methodology: [docs/AGENT-BENCHMARKS.md](docs/AGENT-BENCHMARKS.md).\n\n---\n\n## Is OpenLore for you?\n\n| | |\n|---|---|\n| ✅ **Strong fit** | A codebase too big to hold in your head — and the model's. Private or niche code the model never memorized. Long sessions where stale assumptions compound. Polyglot repos, or code plus the IaC that deploys it. |\n| 🤔 **Try it, measure** | Mid-size repos and mixed workloads. Run **`openlore prove --estimate`** (seconds, no key) before you commit. |\n| ❌ **Probably not** | A small repo the model already knows, answering shallow questions — your agent's built-in search is cheaper, and we [publish the measurement that says so](#value-scorecard--does-it-pay-for-itself). Also: OpenLore locates and certifies, it never edits your code. |\n\n---\n\n## What your agent reaches for (you rarely type these)\n\nOnce wired, your agent calls these over MCP on its own. The default surface is the **`substrate`** preset — **15 tools**: the navigation core, the highest-value governance reads (`recall`, `verify_claim`, `blast_radius`), and the spec composites. The lean **`navigation`** preset (10 tools) and the full **83 tools** (`--preset full`) are one flag away.\n\n| When the agent needs to… | Tool |\n|-----------|------|\n| Start any task | `orient(task)` — functions, callers, specs, insertion points in one call |\n| Find which file/function handles X | `search_code` |\n| Know the blast radius of a change | `analyze_impact` — risk + up/downstream chain + governing decisions |\n| Trace how request X reaches function Y | `trace_execution_path` |\n| Pick the tests a change should run | `select_tests` — backward reachability to the reaching tests |\n| Find dead code / what dies if X is deleted | `find_dead_code` — cross-language reachability |\n| Check a whole diff before commit | `blast_radius` — callers, tests, specs that drift |\n| Tell if a diff opens a sensitive boundary | `change_impact_certificate` |\n| Tell if a change breaks a consumer's API | `certify_public_surface` — verdict, consumers named |\n| Verify a fact before asserting it | `verify_claim` — deterministic verdict + citation |\n| Record an architectural choice | `record_decision` **before** writing the code |\n\nFull reference — all 83 tools: [docs/mcp-tools.md](docs/mcp-tools.md). Ships as a Claude Code [Skill](https://docs.claude.com/en/docs/claude-code/skills) at [`skills/openlore-orient/`](skills/openlore-orient/).\n\n---\n\n## OpenLore vs. alternatives\n\nEveryone in this category answers the same first question: **how does the agent see the codebase without reading it file by file?** LSP toolkits answer with symbols, graph MCP servers with a parsed graph, search platforms with an index. OpenLore answers it too — then keeps going into the **second question almost nobody answers: what happens when the agent starts writing?** A retrieval layer makes an agent *informed*; it doesn't make it *safe*. That second half — **governance on the same graph, no LLM in the loop** — is what OpenLore is for.\n\n| | Agent built-ins | LSP toolkits | Graph MCP | Search platforms | **OpenLore** |\n|---|---|---|---|---|---|\n| Structural context instead of file reads | ❌ grep | ✓ symbols | ✓ graph | ✓ index | ✓ call graph + **IaC + decisions on one graph** |\n| Local, no API key, deterministic | Partial | ✓ | ✓ | ❌ hosted | ✓ no LLM in the hot path |\n| Cross-session memory anchored to code | ❌ | Partial | ✓ notes | ❌ | ✓ **carried across renames** |\n| Told when a cached fact goes **stale** | ❌ | ❌ | ❌ | ❌ | ✓ Epistemic Lease |\n| Breaking-change **verdict** over a diff | ❌ | ❌ | Partial | ❌ | ✓ per export, **consumers named** |\n| \"Did this diff open a sensitive path?\" | ❌ | ❌ | ❌ | ❌ | ✓ differential, pre-commit |\n| Cost effect **published with the losses** | ❌ | ❌ | ❌ | ❌ | ✓ −26% round-trips on deep tasks |\n\n**Use the other tool when it's the right one:** symbol-level *edits* (rename across files) are an LSP toolkit's home turf — OpenLore is deliberately read-only, and the two compose. Org-wide search across hundreds of repos is a search platform. Just-fast-graph-retrieval is a smaller graph MCP server. And a small, familiar repo with shallow questions is cheaper with your agent's built-in search. OpenLore also [exports SCIP](docs/scip-export.md), so it sits alongside these tools, not against them.\n\n*Comparisons reflect each project's publicly documented capabilities as of July 2026; a correction PR is always welcome.*\n\n---\n\n## What it costs\n\nMeasured on a fresh clone of [ripgrep](https://github.com/BurntSushi/ripgrep) with published `openlore@2.1.6`:\n\n| What it costs | On ripgrep (232 files) |\n|---|---|\n| **One-time index build** | **13.6 s**, entirely local — no API key, no network |\n| **Disk** | **27 MB** under `.openlore/` (gitignorable; rebuildable from source) |\n| **Per-query latency** | **~430 µs p50** in-process via the MCP server |\n| **Your source code** | never leaves the machine — no account, no telemetry (opt-in only) |\n| **Lock-in** | none — delete `.openlore/` and nothing about your repo has changed |\n\nLarge monorepos take minutes rather than seconds, stated plainly in [Known limitations](#known-limitations). Platform: Linux and Windows are exercised in CI; macOS is supported.\n\n> **Fully local — nothing phones home.** No account, no network call; your source, the index, and every query stay on your machine. The only diagnostics that exist are **opt-in and local-only**, off by default and never transmitted: `OPENLORE_TELEMETRY=1` records tool calls, agent identity, latency, error messages, decision titles, and lease events to the gitignored `.openlore/telemetry/` directory, and `OPENLORE_LLM_LOGS=1` stores prompts and responses (after secret redaction) in the gitignored `.openlore/logs/` directory. → [docs/configuration.md](docs/configuration.md)\n\n---\n\n## Languages, Infrastructure-as-Code & contracts\n\n**Languages**: TypeScript · JavaScript · Python · Go · Rust · Ruby · Java · C++ · Swift · C# · Kotlin · PHP · C · Scala · Dart · Lua · Elixir · Bash — call graphs ride the same primitives for every language. → [docs/language-support.md](docs/language-support.md)\n\n**Infrastructure-as-Code**: Terraform/HCL · Kubernetes · Helm · CloudFormation · Ansible · Pulumi · AWS CDK · CDKTF · Dockerfile · Docker Compose · GitHub Actions · Azure Bicep · Serverless Framework — IaC resources project onto the **same graph** as application code, so `orient`, `search_code`, and `analyze_impact` answer \"what's the blast radius of changing this security group / IAM role / base image / CI job?\" with zero new tooling. → [docs/iac.md](docs/iac.md)\n\n**Interface contracts**: OpenAPI 3.x · Swagger 2.0 — each declared operation projects onto the **same graph**, bound to the route handler that serves it and the function that calls it, so `orient` and `analyze_impact` cross the API boundary. Matching is literal, and everything unbound is disclosed. → [docs/contracts.md](docs/contracts.md)\n\n---\n\n## Known limitations\n\nWe'd rather you know these up front.\n\n- **Static analysis only.** Polymorphic dispatch, event channels, and route→handler bindings *are* recovered (provenance-labeled `synthesized`). What isn't: reflective invocation with a non-literal target (`getattr(o, name)()`), `eval`, and DI/plugin registries with no visible binding — silently absent from the graph.\n- **LLM spec quality varies.** Generated spec *prose* reflects the model's understanding — review complex business logic. Structure, format, coverage, and drift are checked deterministically.\n- **Keyword (BM25) search answers first; local semantic follows in the background.** `orient`/`search_code` work immediately with no key. Background builds then add on-device vectors (CPU-only, ~23 MB model) when the optional package is installed; opt out with `\"embedding\": { \"provider\": \"none\" }`.\n- **Large monorepos** analyze one package at a time after the first full build (`openlore analyze --shard