Introduction
Persistent, repo-local knowledge for coding agents. hallouminate stores markdown verbatim on disk, embeds it with fastembed, indexes the embeddings in LanceDB, and exposes a small MCP surface so an LLM can author and search a per-repo knowledge base without leaving its agent loop.
The filesystem is the source of truth; LanceDB rows are derived and refreshed
automatically when an LLM writes via add_markdown, or in bulk via
hallouminate index. Code files (.rs, .toml, …) can also be indexed as
text for semantic search, but hallouminate does no structural analysis — it’s
a wiki indexer that happens to tolerate code, not a code-intelligence tool.
Why a daemon
Section titled “Why a daemon”A long-lived local daemon owns the LanceDB ground directory, per-corpus mutation locks, and config resolution. The CLI and the stdio MCP server both talk to it over a Unix domain socket — one owner, no cross-process LanceDB races. See Architecture for the full picture.
Where to go next
Section titled “Where to go next”- Installation — install the binary and register the MCP server with your agent.
- How it compares — choose between repo-local markdown, agent memory, and knowledge-graph tools.
- CLI reference — every subcommand and its flags.
- MCP surface — the ten tools an LLM calls to author and search wikis.
- Configuration — the XDG baseline, repo-layer merge, and embedding-model options.
- Dogfooding — this repo maintains its own wiki with hallouminate; here’s how to read it.
License
Section titled “License”MIT — see LICENSE.