beepboopbitLore
Search Markdown documentation in plain language and follow the results to their source passages.
Lore helps me find the relevant parts of a project’s documentation. It indexes Markdown files, searches with a small local model, and returns passages with file paths and section references. Use it from a terminal or connect it to a coding agent through MCP.
Find the docs worth reading.
Ask in plain language
Search documentation with a question, narrow results to a directory, or use keyword mode for an exact term.
Follow the source
Explore a document’s headings and read the matching section with its surrounding context. JSON output keeps source references available to other tools.
Keep searches local
After the initial model download, indexing and search work offline. The MCP server gives a coding agent access to one prepared project index.
Install
Run from any directory with Rust 1.88+ and a C/C++ toolchain installed. Cargo builds the published lore-docs package and installs the lore executable.
cargo install lore-docs --lockedNext step
After installation, run these commands from the project you want to search. The first command downloads the search model (about 67 MB); the second indexes its Markdown files.
lore model install
lore index .Before you start
Rust 1.88+ · C/C++ toolchain · Initial model download
Linux x86-64 is the tested platform. Each index belongs to one project and lives in .lore/ by default. Rerun lore index . after editing docs; there is no automatic watcher. Search returns source passages for you to read and assess.
What it looks like to use
# From the project directory, after indexing
lore brief "How do I configure this project?"
lore outline README.md
lore read README.md --json