🚀 Manx - Lightning-Fast Documentation Finder

Find code snippets, documentation, and answers instantly from your terminal

📚 Setup Guide • 🔍 Commands • ⚙️ Configuration • 🧠 AI Features

🎥 See Manx in Action

Click to watch: Complete walkthrough of Manx features and capabilities

⚡ Quick Start

# Install and run setup wizard
cargo install manx-cli
manx init  # Interactive setup wizard

# Or install and start immediately
curl -fsSL https://raw.githubusercontent.com/neur0map/manx/main/install.sh | bash

# Find code snippets instantly
manx snippet react "useState hook"
manx snippet python "async functions"

# Search documentation and crawl sites
manx search "rust error handling"
manx doc fastapi "middleware"
manx index https://docs.rs/ --crawl

Works immediately! No setup required, enhanced with the manx init wizard.

✨ What is Manx?

Manx helps developers find answers fast with four powerful modes:

Progressive Enhancement

Start simple → Add semantic search → Index your docs → Enable AI

🎯 Core Features

Code Snippet Search

manx snippet react "custom hooks"
manx snippet python "decorators"
manx snippet rust "error handling"

Get working code examples with explanations from official documentation

Documentation Search

manx search "authentication best practices"
manx doc fastapi "dependency injection"

Search official docs across hundreds of frameworks and languages

Personal Knowledge Base

# Index local documentation or crawl websites
manx index ~/dev-notes/
manx index https://docs.python.org --crawl --max-depth 2

# Search with semantic understanding
manx search "team coding standards" --rag

Index local files or crawl documentation sites for private search

AI-Powered Analysis (Optional)

manx init  # Setup wizard includes AI configuration
manx snippet react hooks  # Now includes AI explanations

Get comprehensive answers with code examples, explanations, and citations

🚀 Why Manx?

• ⚡ Instant: Works immediately after installation
• 🎯 Accurate: Searches official documentation, not forums
• 🧠 Smart: Optional semantic search understands intent
• 🔒 Private: Your documents never leave your machine
• ⚙️ Flexible: Choose your level of enhancement
• 🚀 Fast: Optimized Rust performance with embedded ONNX Runtime

📚 Learn More

• 🔧 Setup Guide - Complete installation and configuration
• 📖 Commands Reference - All commands with examples
• ⚙️ Configuration - Customize settings and providers
• 🧠 AI Features - LLM integration and capabilities
• 📁 RAG Mode - Index and search personal documentation
• 🔍 Neural Search - Enhanced semantic understanding

📦 Installation

Quick Install Script

curl -fsSL https://raw.githubusercontent.com/neur0map/manx/main/install.sh | bash

Automatically detects your platform and installs the latest release

Cargo (Alternative)

cargo install manx-cli

Manual Download

• Binary: Download from GitHub Releases

🆘 Getting Help

• 📖 Documentation: Check the guides linked above
• 🐛 Issues: GitHub Issues

🙏 Shoutouts

Huge thanks to the amazing open source community and projects that make Manx possible:

• Anthropic - For Claude and the incredible Claude Code IDE
• Context7 - For providing the documentation API that powers default search
• Hugging Face - For the neural embedding models and infrastructure
• ONNX Runtime - For fast, local neural inference
• Rust Community - For the amazing ecosystem and libraries

💡 Built with AI

This tool was fully built through "vibe coding" with Claude Code 🤖

I'm not a programmer - just a cybersecurity student learning the basics and building tools for my own use under prowl.sh. If people find these tools useful, I'm more than happy to continue working on them and improving the experience!

📋 Roadmap

Release Binaries

The install script currently falls back to cargo compilation when pre-built binaries aren't available. Future releases should include binaries for:

• ✅ x86_64-apple-darwin (Intel Mac)
• ✅ aarch64-apple-darwin (Apple Silicon Mac)
• ✅ x86_64-pc-windows-msvc (Windows x64)
• ⏳ aarch64-unknown-linux-gnu (ARM64 Linux - Raspberry Pi, ARM servers)

GitHub Repository Search

Future enhancement to search directly within GitHub repositories for code examples and implementation patterns:

• ⏳ GitHub Access: Search repositories, issues, and discussions from the CLI
• ⏳ Code Search: Look through repo code with the option to add extra context using embeddings
• ⏳ Issue Tracking: Pull in issues and make them easier to reference alongside other results
• ⏳ Docs Indexing: Treat READMEs and repo docs as part of the searchable database
• ⏳ Extra Context: When needed, let an LLM help summarize or clarify what the search finds

Integration with Manx Intelligence:

• 🧠 Embedding-Enhanced Code Search: Neural embeddings understand code similarity and patterns
• 🤖 LLM Code Analysis: Synthesize solutions from multiple repos with explanations
• 🎯 Smart Query Routing: Framework detection automatically searches relevant repositories
• 📊 Hybrid Results: Combine web docs + GitHub code + issue discussions in unified answers
• 🔍 Semantic Issue Search: Find related problems even with different terminology

Example: manx search "Tauri tables" would search official docs AND tauri-apps/tauri repo for real implementations.

📄 License

GPL-3 © neur0map

Happy coding! 🚀