# 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>
## Demo Video
<div align="center">
[](https://www.youtube.com/watch?v=3gINTsmHnYA)
Click to watch: Complete walkthrough of Manx features and capabilities
</div>
## Quick Start
```bash
# Install and run setup wizard
cargo install manx-cli
manx init # Interactive setup wizard
# Exisiting users
manx update
# Or install and start immediately
# 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 with no setup required. Enhanced features available through the `manx init` wizard.
## What is Manx?
Manx helps developers find answers fast with four modes:
| **Default** | None | Official docs + keyword search (works instantly) |
| **Enhanced** | Download neural model | Neural search + semantic understanding |
| **RAG** | Index docs and sites | 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"
```
Retrieves code examples with explanations from official documentation.
### Documentation Search
```bash
manx search "authentication best practices"
manx doc fastapi "dependency injection"
```
Searches official documentation across frameworks and languages.
### Personal Knowledge Base
```bash
# Index local documentation or crawl websites
manx index ~/dev-notes/
manx index https://docs.python.org --crawl-depth 2
manx index https://react.dev --crawl-all
# Search with semantic understanding
manx search "team coding standards" --rag
```
Index local files or crawl documentation sites for private search.
### AI-Powered Analysis (Optional)
```bash
manx init # Setup wizard includes AI configuration
manx snippet react hooks # Includes AI explanations when configured
```
Provides 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
### 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)
## Acknowledgments
Thanks to the open source community and projects that make Manx possible:
- [Anthropic](https://anthropic.com) - For Claude and Claude Code IDE
- [Context7](https://context7.com/) - For providing the documentation API
- [Hugging Face](https://huggingface.co) - For neural embedding models
- [ONNX Runtime](https://onnxruntime.ai) - For local neural inference
- [Rust Community](https://rust-lang.org) - For the ecosystem and libraries
## Built with AI
Built using [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!
## Roadmap
### 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 optional embeddings for context
- 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: Optional LLM summarization and clarification
Example: `manx search "Tauri tables"` would search official docs AND `tauri-apps/tauri` repo for implementations.
## Star History
<a href="https://star-history.com/#neur0map/manx&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=neur0map/manx&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=neur0map/manx&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=neur0map/manx&type=Date" />
</picture>
</a>
## License
GPL-3 © [neur0map](https://github.com/neur0map)
