kdex-0.0.4 is not a library.
The Problem
You have knowledge everywhere:
- Code across dozens of repositories
- Notes in Obsidian, Logseq, or markdown files
- Docs scattered in wikis and READMEs
When you ask an AI assistant for help, it has no idea what's in YOUR files. You end up copy-pasting context manually.
The Solution
# Index everything
# Search instantly
# AI assistants can now search your knowledge
kdex creates a local search index that AI tools can query. Your data never leaves your machine.
β¨ Features
| Feature | Description |
|---|---|
| π Instant Search | SQLite FTS5 gives sub-millisecond full-text search |
| π€ AI-Ready | MCP server for GitHub Copilot, Claude, Ollama |
| π Universal | Code repos, Obsidian vaults, wikis, any markdown |
| π Local-First | Your data stays on your machine. Always. |
| β‘ Fast | Index 100k files in seconds, search in milliseconds |
| π Remote Repos | Add GitHub repos by URLβauto-cloned, auto-synced |
| π¦ Portable | Export/import config for easy machine migration |
| π₯οΈ Interactive TUI | Full-screen interface with preview panel |
π Quickstart
# Install
# Index your project
# Add a GitHub repo
# Search (just type your query!)
# Launch interactive mode
That's it. Your knowledge, instantly searchable.
π€ AI Integration
kdex speaks MCP (Model Context Protocol), so AI assistants can search your indexed content directly.
GitHub Copilot CLI
Add to ~/.config/github-copilot/mcp.json:
Claude Desktop
Add to ~/.config/claude/claude_desktop_config.json:
Ollama (Local LLMs)
Pipe search results to your local model:
| \
| \
See MCP Integration Guide for more details.
π What It Indexes
| Source | Examples |
|---|---|
| Code Repositories | Any git repo, monorepos, microservices |
| Knowledge Bases | Obsidian vaults, Logseq graphs, Dendron |
| Documentation | Markdown wikis, READMEs, technical docs |
| Config Files | YAML, TOML, JSON with searchable content |
kdex respects .gitignore and skips binary files automatically.
π» Usage
Interactive Mode (TUI)
Full-screen interface with:
- Real-time search as you type
- File preview panel (
Ctrl+P) - Repository management
- Keyboard-driven navigation
Command Line
Run kdex --help for all options.
π§ Installation
From crates.io (recommended)
From source
Requirements
- Rust 1.88+ (install via rustup)
- Works on Linux, macOS (Apple Silicon), and Windows
π Documentation
- Features β Full feature list
- Documentation β Detailed usage guide
- MCP Integration β AI assistant setup
- Ollama Integration β Local LLM workflow
- Roadmap β What's coming next
π οΈ Development
See CONTRIBUTING.md for development setup.
License
MIT Β© urbanisierung