# 🚀 Manx - Lightning-Fast Documentation Finder
> *Find code snippets, documentation, and answers instantly from your terminal*
<div align="center">
**📚 [Setup Guide](docs/SETUP_GUIDE.md) • 🔍 [Commands](docs/COMMANDS.md) • ⚙️ [Configuration](docs/CONFIGURATION.md) • 🧠 [AI Features](docs/AI_FEATURES.md)**
</div>
## ⚡ Quick Start
```bash
# Install
cargo install manx-cli
# or directly from GitHub
# 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:
| **🚀 Default** | None | Official docs + keyword search (works instantly) |
| **🧠 Enhanced** | 1 command | Neural search + semantic understanding |
| **📁 RAG** | Index docs | Search your private documentation |
| **🤖 AI** | Add API key | Full synthesis with explanations + citations |
### Progressive Enhancement
Start simple → Add semantic search → Index your docs → Enable AI
## 🎯 Core Features
### **Code Snippet Search**
```bash
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**
```bash
manx search "authentication best practices"
manx doc fastapi "dependency injection"
```
*Search official docs across hundreds of frameworks and languages*
### **Personal Knowledge Base**
```bash
manx index ~/dev-notes/
manx search "team coding standards" --rag
```
*Index and search your own documentation with semantic understanding*
### **AI-Powered Analysis** *(Optional)*
```bash
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](docs/SETUP_GUIDE.md)** - Complete installation and configuration
- **📖 [Commands Reference](docs/COMMANDS.md)** - All commands with examples
- **⚙️ [Configuration](docs/CONFIGURATION.md)** - Customize settings and providers
- **🧠 [AI Features](docs/AI_FEATURES.md)** - LLM integration and capabilities
- **📁 [RAG Mode](docs/RAG_GUIDE.md)** - Index and search personal documentation
- **🔍 [Neural Search](docs/NEURAL_SEARCH.md)** - Enhanced semantic understanding
## 🏃♂️ Daily Workflows
### **Quick Development**
```bash
manx snippet python "list comprehensions" # Learning
manx search "javascript memory leaks" # Debugging
manx doc svelte "component lifecycle" # Reference
```
### **Team Knowledge**
```bash
manx index ~/team-docs/ # One-time setup
manx search "deployment checklist" --rag # Daily usage
```
### **Research Mode**
```bash
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
```bash
*Automatically detects your platform and installs the latest release*
### Cargo (Alternative)
```bash
cargo install manx-cli
```
### Manual Download
- **Binary**: Download from [GitHub Releases](https://github.com/neur0map/manx/releases)
## 🆘 Getting Help
- **📖 Documentation**: Check the guides linked above
- **🐛 Issues**: [GitHub Issues](https://github.com/neur0map/manx/issues)
## 🙏 Shoutouts
Huge thanks to the amazing open source community and projects that make Manx possible:
- **[Anthropic](https://anthropic.com)** - For Claude and the incredible Claude Code IDE
- **[Context7](https://context7.sh)** - For providing the documentation API that powers default search
- **[Hugging Face](https://huggingface.co)** - For the neural embedding models and infrastructure
- **[ONNX Runtime](https://onnxruntime.ai)** - For fast, local neural inference
- **[Rust Community](https://rust-lang.org)** - For the amazing ecosystem and libraries
## 💡 Built with AI
This tool was fully built through "vibe coding" with **[Claude Code](https://claude.ai/code)** 🤖
I'm not a programmer - just a cybersecurity student learning the basics and building tools for my own use under [prowl.sh](https://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](https://github.com/neur0map)
---
*Happy coding! 🚀*
