Expand description
Open Knowledge Catalog (OKC) - A markdown knowledge base indexer and query engine.
This crate provides the core functionality for indexing, searching, and querying markdown-based knowledge repositories with front-matter metadata, wiki-style links, and graph-based navigation.
§Architecture
The crate is organized into the following modules:
config- Configuration types and defaults for the indexerindex- Storage layer: database, search index, graph store, and migrationsmodel- Core data types: documents, front-matter, links, graph structuresparser- Parsing pipeline: front-matter, markdown, links, YAMLscanner- File system scanning, change detection, and watchingservice- High-level service API for CLI and MCP servertransport- Transport layer: CLI commands and MCP (Model Context Protocol) server
§Example
use okc::{config::OkcConfig, service::OkcService};
let config = OkcConfig::default();
let mut service = OkcService::open(&config)?;
let result = service.scan()?;
println!("Indexed {} files", result.total_files);Modules§
- config
- Configuration types for the Open Knowledge Catalog indexer.
- index
- Storage layer for the Open Knowledge Catalog.
- model
- Core data models for the Open Knowledge Catalog.
- parser
- Parsing pipeline for markdown documents with front-matter.
- scanner
- File system scanning, change detection, and watching.
- service
- High-level service API for CLI and MCP server.
- transport
- Transport layer: CLI and MCP (Model Context Protocol) server.