Quick Start
Compile your first wiki from a single source in under five minutes.
Installation
Install llmwiki and configure your LLM provider.
How It Works
Understand the two-phase compile pipeline and hybrid retrieval model.
Configurable Lifecycle Profiles
Model typed entities, relations, lifecycles, workflows, artifacts, and connectors as validated configuration.
Open Knowledge Format
Exchange compiled knowledge with OKF-aware tools while preserving provenance.
MCP Integration
Connect llmwiki to Claude Desktop, Cursor, or Claude Code via MCP.
Make the wiki your own
The local viewer offers four themes: Scientific Clay, Minimal, Nebula Light, and Nebula Dark. Scientific Clay is the default, with soft surfaces and rounded typography. Minimal follows your system’s light or dark setting. Switch themes without leaving the page; existing saved light/dark preferences migrate to Nebula. See the theme guide for preference behavior. Organize inputs with recursive source folders and literal path exclusions, supply project-specific compile instructions, and use binary embedding storage for larger indexes. Binary storage avoids the JSON serialization limit; semantic retrieval still requires the index to fit in memory.What llmwiki gives you
A compiled wiki, not raw chunks. Instead of storing document chunks and re-discovering relationships at every query, llmwiki runs a two-phase LLM pipeline that extracts concepts, merges duplicates across sources, and generates typed wiki pages - each with citations back to the original source lines. A domain model without a domain fork. Install a declarative template or author.llmwiki/profile.json to define the entities, relations, lifecycle gates, workflows, artifacts, and connectors for your project. The same generic runtime validates and surfaces every profile across the CLI, SDK, MCP, viewer, context packs, lint, status, and export.
Semantic search that gets smarter. After compiling, llmwiki builds chunk-level embeddings. When you run llmwiki query, it narrows hundreds of pages to a top-K via cosine similarity, reranks with BM25, and expands along the wikilink graph - giving you a tight, citation-traceable evidence pack.
A local web viewer. llmwiki view opens your compiled wiki in a browser - sidebar navigation, full-text search, a force-directed page graph, and provenance chips on every paragraph.
Agent-ready via MCP. llmwiki serve exposes the full pipeline to Claude Desktop, Cursor, Claude Code, and any MCP-compatible agent. Agents can ingest sources, compile, query, lint, retrieve context packs, and exchange OKF bundles without touching the CLI.
Open Knowledge Format round-trip. llmwiki export --target okf writes a Google OKF-style bundle with page docs, references, and an activity log. llmwiki import --okf stages external bundles for review by default, so third-party knowledge does not touch your live wiki until you approve it. Imported foreign pages re-export at their safe original paths when possible.
Programmatic control via SDK. createWiki({ root }) drives the entire pipeline in-process - no shelling out, no console noise, fully typed, including OKF import/export.
Who uses llmwiki
- AI researchers and engineers building durable knowledge bases from papers, docs, and notes
- Technical writers compiling scattered sources into a structured, interlinked reference
- Open-source maintainers turning READMEs, ADRs, and design docs into a navigable knowledge base
- Developers who want to give their AI agents persistent, well-structured context
Compile, don’t just retrieve
llmwiki requires Node.js ≥ 24 and an LLM provider credential (Anthropic API key, OpenAI-compatible endpoint, Ollama, GitHub Copilot, or local Claude Code login). See Installation for setup details.