kdex

All your knowledge. One search. AI-ready.

Index your code, docs, notes, and wikis locally.
Let AI assistants search everything you know.

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
kdex index ~/code/my-project
kdex index ~/Documents/obsidian-vault
kdex index ~/wiki

# Search instantly
kdex search "how to deploy"

# AI assistants can now search your knowledge
kdex mcp  # Start MCP server for Copilot, Claude, Ollama

kdex creates a local search index that AI tools can query. Your data never leaves your machine.

✨ Features

🚀 Quickstart

# Install
cargo install kdex

# Index your project
kdex index .

# Add a GitHub repo
kdex add --remote owner/repo

# Search (just type your query!)
kdex "authentication"

# Launch interactive mode
kdex

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:

{
  "mcpServers": {
    "kdex": { "command": "kdex", "args": ["mcp"] }
  }
}

Claude Desktop

Add to ~/.config/claude/claude_desktop_config.json:

{
  "mcpServers": {
    "kdex": { "command": "kdex", "args": ["mcp"] }
  }
}

Ollama (Local LLMs)

Pipe search results to your local model:

kdex search "error handling" --json | \
  jq -r '.results[].snippet' | \
  ollama run llama3 "Explain this code:"

See MCP Integration Guide for more details.

📖 What It Indexes

kdex respects .gitignore and skips binary files automatically.

💻 Usage

Interactive Mode (TUI)

kdex

Full-screen interface with:

• Real-time search as you type
• File preview panel (Ctrl+P)
• Repository management
• Keyboard-driven navigation

Command Line

kdex index <path>              # Index a directory
kdex search <query>            # Search indexed content
kdex search <query> --json     # JSON output for scripting
kdex list                      # List indexed repositories
kdex remove <path>             # Remove from index
kdex mcp                       # Start MCP server

Run kdex --help for all options.

🔧 Installation

Quick Install (recommended)

curl -sSf https://urbanisierung.github.io/kdex/install.sh | sh

This downloads the latest binary and installs it to ~/.local/bin. No Rust required.

To update, re-run the same command.

From crates.io

cargo install kdex

From source

git clone https://github.com/urbanisierung/kdex.git
cd kdex
cargo install --path .

Pre-built binaries

Download from GitHub Releases.

Requirements

• Linux or macOS (Windows: use cargo install or pre-built binaries)
• For building from source: Rust 1.88+ (install via rustup)

📚 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

make ci        # Run full CI pipeline (Docker)
make ci-quick  # Quick checks (format + clippy)
make test      # Run tests
make build     # Build debug binary

See CONTRIBUTING.md for development setup.

License

MIT © urbanisierung