code-xray 0.1.0

Terminal-based code explainer powered by Ollama

🧠 code-xray

code-xray is a terminal-based code exploration and explanation tool powered by local LLMs (like Ollama).
Select lines of code interactively, send them for explanation, and get human-friendly insights – right in your terminal.

---

✨ Features

• ✅ Terminal-based file viewer with syntax highlighting
• ✅ Line-by-line navigation and selection
• ✅ Integration with local LLMs via Ollama
• ✅ On-demand code explanation using selected lines and full-file context
• ✅ Works fully offline
• ✅ Customizable LLM model and port via CLI

---

🚀 Usage

1. Basic Command

code-xray /path/to/your/file.py

This opens an interactive terminal interface to browse and explain code.

2. With Custom Model and Port

code-xray /path/to/your/file.py --model mistral --port 11434

• --model or -m: LLM model name (e.g. mistral, llama3, codellama)
• --port or -p: Port where Ollama is running (default is 11434)

---

🧭 Keybindings

Key	Action
h	Move up one line
l	Move down one line
Shift+h	Expand selection up
Shift+l	Expand selection down
e	Explain selected code
q	Quit viewer or popup
Esc	Close explanation popup

---

🛠 Requirements

• Python 3.10+
• Ollama running locally with desired model pulled

Example to pull a model:

ollama pull mistral

Then ensure it's running:

ollama serve

---

🧩 Installation

git clone https://github.com/yourusername/code-xray.git
cd code-xray
pip install -e .

Make sure code-xray is available in your PATH or create an alias.

---

🤖 Example Output

---

📄 License

MIT License © 2024 Aayush Rajesh Jadhav

---

🙌 Acknowledgements

• Textual for the beautiful terminal UI
• Ollama for local model hosting
• Rich for the syntax highlighting

---

🔗 Contributions

Pull requests welcome! Feel free to fork and build on top of this.