🚀 Manx - Lightning-Fast Documentation Finder

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

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

⚡ Quick Start

# Install
cargo install manx-cli
# or directly from GitHub
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 on the web
manx search "rust error handling"
manx doc fastapi "middleware"

# index your local docs or web doc pages.
manx index /path/to/docs
manx index https://docs.rs/

That's it! Works immediately with no setup required.

✨ 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

manx index ~/dev-notes/
manx search "team coding standards" --rag

Index and search your own documentation with semantic understanding

AI-Powered Analysis (Optional)

manx config --openai-api "sk-your-key"
manx snippet react hooks  # Now includes AI explanations

Get comprehensive answers with code examples, explanations, and citations

📚 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

🏃‍♂️ Daily Workflows

Quick Development

manx snippet python "list comprehensions"     # Learning
manx search "javascript memory leaks"         # Debugging  
manx doc svelte "component lifecycle"         # Reference

Team Knowledge

manx index ~/team-docs/                       # One-time setup
manx search "deployment checklist" --rag      # Daily usage

Research Mode

manx config --openai-api "sk-key"            # Enable AI
manx search "microservices architecture"      # Get comprehensive analysis

🚀 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

📦 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!

📋 Todo

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-unknown-linux-gnu (Intel/AMD Linux)
• ✅ 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)
• ⏳ x86_64-unknown-linux-musl (Alpine Linux, static binaries)

This will make installation faster and eliminate the need for Rust/Cargo on target systems.

📄 License

MIT © neur0map

Happy coding! 🚀