Package Exports
- code-aura
- code-aura/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (code-aura) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Code Aura 🔍✨
A powerful CLI tool for semantic code search and exploration using AI-powered embeddings and GROQ's lightning-fast inference.
Features
- Semantic Code Search: Find code using natural language queries
- AI-Powered Explanations: Get detailed explanations of code snippets
- Visualization: Generate HTML and image visualizations of search results
- Multi-language Support: Works with JavaScript, TypeScript, Python, Java, C++, and more
- Smart Chunking: Intelligent code splitting for better search results
Installation
npm install -g code-auraOr use directly with npx:
npx code-aura@latest <command>Quick Start
Get a GROQ API Key:
- Visit console.groq.com
- Sign up and get your free API key
Setup your codebase:
code-aura setup /path/to/your/codebase
Search your code:
code-aura search
Usage
Setup a Codebase
code-aura setup /path/to/your/projectSemantic Search
code-aura searchGenerate HTML Visualization
code-aura html "your search query"Explain a File
code-aura explain path/to/file.jsDebug Information
code-aura debugClear Cache
code-aura clearCommands
setup <path>- Process a codebase for semantic searchsearch- Interactive semantic searchhtml <query>- Generate HTML visualization for a queryexplain <file>- Get explanation of a specific filedebug- Show debug informationclear- Clear cached datareprocess- Reprocess codebase with improved chunking
API Key Setup
The tool will automatically prompt you for your GROQ API key on first run. You can:
- Enter it interactively when prompted
- Create a
.envfile withGROQ_API_KEY=your_key_here - Set it as an environment variable
Supported Languages
- JavaScript/TypeScript (.js, .jsx, .ts, .tsx)
- Python (.py)
- Java (.java)
- C/C++ (.c, .cpp, .h, .hpp)
- Ruby (.rb)
- Go (.go)
- Rust (.rs)
- PHP (.php)
- C# (.cs)
How It Works
- Code Processing: Splits your code into semantic chunks
- Embedding Generation: Creates vector embeddings for each chunk
- Semantic Search: Uses cosine similarity to find relevant code
- AI Explanation: Leverages GROQ's LLM for intelligent code explanations
Performance
- Fast processing with optimized chunking
- Efficient similarity search
- Low memory footprint
- Quick response times with GROQ's accelerated inference
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT License - feel free to use this tool for your projects!
Support
For issues and questions:
- GitHub Issues: github.com/harjas-romana/codeAura
- LinkedIn: Harjas Singh
Star History
If you find this tool useful, please give it a star ⭐ on GitHub!