Allex Coder 🚀

AI-powered CLI tool to understand your codebase

Scan, analyze, and interact with your code using powerful AI — directly from your terminal.

✨ Features

• 🔍 Scan codebase
• 🌳 Project tree visualization
• 🤖 Ask questions about your code
• 🧠 AI-powered file explanation
• 🌐 English + Bangla support
• ⚡ Fast CLI experience

📦 Installation

npm install -g allex-coder

🔑 OpenAI API Key Setup

Allex Coder uses OpenAI API, so you must set your API key.

🔹 Linux / macOS

Temporary:

export OPENAI_API_KEY="your_api_key_here"

Permanent (Bash):

echo 'export OPENAI_API_KEY="your_api_key_here"' >> ~/.bashrc
source ~/.bashrc

Permanent (Zsh):

echo 'export OPENAI_API_KEY="your_api_key_here"' >> ~/.zshrc
source ~/.zshrc

🔹 Windows (PowerShell)

setx OPENAI_API_KEY "your_api_key_here"

👉 Restart terminal after this

🚀 Usage

1. Scan your project

allex scan .

2. Ask questions

allex ask "how does authentication work?"

Bangla:

allex ask "scan command কীভাবে কাজ করে?" --lang bn

Show related files:

allex ask "auth logic" --show-files

3. Explain a file

allex explain src/app.js

4. Show project structure

allex tree .

🧪 Example Workflow

allex scan .
allex ask "how does scan command work?"
allex explain src/commands/scan.js

⚠️ Common Error

❌ Missing API Key

Missing credentials. Please set OPENAI_API_KEY

✅ Fix

export OPENAI_API_KEY="your_api_key_here"

🛠 Commands

allex scan .
allex tree .
allex ask "your question"
allex ask "your question" --lang bn
allex ask "your question" --show-files
allex explain <file>

🧠 How It Works

1. scan → indexes your codebase
2. ask → finds relevant code chunks
3. AI → generates contextual answer
4. explain → analyzes specific file

🔐 Security

⚠️ Never expose your API key

Do NOT:

• ❌ commit to GitHub
• ❌ hardcode in source code
• ❌ share publicly

🧑‍💻 Tech Stack

• Node.js (CLI)
• OpenAI API
• Commander
• Chalk
• Fast-glob

🚧 Roadmap

• [ ] Vector search (embeddings)
• [ ] Project memory
• [ ] Config system
• [ ] Plugin support
• [ ] VS Code extension

🤝 Contributing

Pull requests are welcome!

📄 License

MIT

⭐ Support

If you like this project, give it a ⭐ on GitHub!