LoreHub Documentation
Work in Progress: LoreHub is under active development. This documentation may not reflect the current feature set. For the latest updates, check the GitHub repository .
Welcome to LoreHub - a knowledge management system for capturing and surfacing the collective wisdom of your codebases.
LoreHub helps development teams track technical decisions, patterns, and lessons learned across projects, ensuring valuable knowledge is never lost.
What is LoreHub?
LoreHub is a Model Context Protocol (MCP) server that helps development teams track decisions, patterns, and lessons learned across multiple codebases. It captures:
- 🏛️ Architectural decisions - Document the “why” behind your design choices
- 📚 Lessons learned - Preserve hard-won wisdom from debugging sessions
- ⚠️ Known risks - Track potential issues and their mitigations
- 📋 Requirements - Keep business and technical requirements accessible
- 🎯 Technical constraints - Document limitations and workarounds
- 🔮 Future tasks - Track quests and investigations needed
Key Features
- 🔍 Intelligent Search - Three search modes: literal, semantic (AI-powered), and hybrid. Learn more →
- ⚡ Lightning Fast - SQLite-based with vector embeddings for instant results. Learn more →
- 🔒 Privacy First - All data stored locally with optional Git-based sync. Learn more →
- 📦 Monorepo Ready - Track decisions across services with province support. Learn more →
Quick Start
Get up and running in under a minute:
# Install globally
npm install -g lorehub
# Browse existing lores
lh browse
# Add your first lore (interactive)
lh add
# Or add inline
lh add "Always validate input at the API boundary" --type wisdom --confidence 90How It Works
- Capture - Record decisions as they’re made using the CLI
- Organize - Categorize with types, tags (sigils), and confidence levels
- Search - Find relevant knowledge using keywords or AI-powered semantic search
- Evolve - Update, supersede, or archive lores as your understanding grows
Core Concepts
- Lores - Individual pieces of knowledge (decisions, lessons, risks, etc.)
- Realms - Codebases or repositories being tracked
- Provinces - Services/modules within monorepos
- Sigils - Tags for categorizing lores
- Relations - Links between lores (supersedes, supports, contradicts)
- Search Modes - Literal (exact), Semantic (AI), or Hybrid search
Why LoreHub?
Traditional documentation often fails to capture the context and evolution of technical decisions. LoreHub solves this by:
- Making it easy to record knowledge in the moment
- Providing powerful search to surface relevant information
- Tracking how decisions evolve over time
- Keeping knowledge close to the code
Next Steps
- 📖 Getting Started - Installation, setup, and your first lores
- 🧠 Core Concepts - Understand lores, realms, and search modes
- ⌨️ Commands - Complete CLI reference
- 🚀 Guides - Best practices and workflows