emdx - Documentation Index Management System

A powerful command-line tool for managing your personal knowledge base with SQLite full-text search, Git integration, and a modern terminal interface.

✨ Key Features

• 🔍 Fast Search - SQLite FTS5 full-text search with ranking
• 🎨 Rich TUI - Multiple browser modes (documents, files, git diffs) with vim editing
• 🏷️ Smart Tagging - Emoji tags with intuitive text aliases (gameplan→🎯, active→🚀)
• 🤖 AI Agents - Create custom agents for research, analysis, and automation
• ⚡ Claude Integration - Execute documents directly with Claude Code
• 🔧 Git Aware - Auto-detects projects, diff viewer, worktree switching
• 💾 Zero Setup - SQLite backend, no database server required

🚀 Quick Start

Installation

git clone https://github.com/arockwell/emdx.git
cd emdx
pip install -e .

Basic Usage

# Save content
emdx save README.md
echo "Remember to fix the API" | emdx save --title "API Note"

# Search documents  
emdx find "docker compose"
emdx find --tags "gameplan,active"

# Launch TUI browser
emdx gui

Agent Usage

# List available agents
emdx agent list

# Run an agent on a document
emdx agent run code-reviewer --doc 123

# Create custom agent via TUI
emdx gui  # Then press 'a' for agent browser

Key TUI Commands

• j/k - Navigate up/down
• e - Edit with vim
• f - File browser mode
• d - Git diff browser
• l - Log browser
• a - Agent browser
• x - Execute with Claude
• q - Quit/back

📚 Documentation

For comprehensive guides and detailed information:

• 📖 Complete Documentation - Full project documentation
• 🤖 AI Agents Guide - Agent system overview and user guide
• 🏗️ Architecture - System design and code structure
• ⚙️ Development Setup - Contributing and development guide
• 📋 CLI Reference - Complete command documentation
• 🎨 UI Guide - TUI components and key bindings

💡 Common Workflows

Knowledge Management

# Quick note capture
echo "Bug in auth system" | emdx save --title "Auth Bug" --tags "bug,urgent"

# Research documentation  
emdx save research.md --tags "analysis,done"
emdx find --tags "analysis"

# Project tracking
echo "Phase 1: Setup infrastructure" | emdx save --title "Project Plan" --tags "gameplan,active"

AI Agent Workflows

# Run code review on recent changes
emdx agent run code-reviewer

# Generate weekly summary from your notes
emdx agent run weekly-summary --query "last 7 days"

# Research a topic across your knowledge base
emdx agent run researcher --query "kubernetes best practices"

# Create custom agent for your workflow
emdx gui  # Press 'a', then 'n' to create new agent

TUI Browser

# Launch interactive browser
emdx gui

# Navigation modes:
# - Documents (default): manage knowledge base
# - Files (f): browse filesystem with preview
# - Git (d): visual diff viewer, worktree switching  
# - Logs (l): execution monitoring
# - Agents (a): AI agent management and execution

🔧 Configuration

• Database: ~/.emdx/emdx.db (created automatically)
• GitHub Integration: Set GITHUB_TOKEN or use gh auth login
• Editor: Set EDITOR environment variable for external editing

🤝 Contributing

See Development Setup for:

• Installation with Poetry
• Code quality tools
• Testing guidelines
• Architecture patterns

📄 License

MIT License - see LICENSE file for details.

---

Quick Links: Installation • Documentation • CLI Reference • Contributing