DevLens

<img width="100%" src="https://github.com/user-attachments/assets/1883a4eb-2892-4e9d-81cb-dc54cee2b0ea"/> <h2 align="center">How to Use It</h2> <p align="center"><i>Quick guide to start analyzing your codebase</i></p> <p align="center"> <img width="100%" src="https://github.com/user-attachments/assets/b0e6681b-9c2d-4cae-b3dd-71d599594abf" /> </p>

---

<h2 align="center">Illuminate Your Codebase with Powerful Analysis</h2> <p align="center"><i>AI-powered insights & detailed statistics for your repository</i></p> <p align="center"> <img src="https://github.com/user-attachments/assets/b8e9fdb9-2b19-4ff6-9c6d-72d785ce02e6" width="48%"/> <img src="https://github.com/user-attachments/assets/990308a1-83a2-40ba-bb99-182b5ba41434" width="48%"/> </p>

---

<h2 align="center">Complete Codebase Insights</h2> <p align="center"><i>Total files, lines of code, directories, language breakdown, and detailed project structure</i></p> <p align="center"> <img src="https://github.com/user-attachments/assets/88402183-93e9-48f2-bce5-2a9ae79d8fb0" width="48%"/> <img src="https://github.com/user-attachments/assets/c32a43d2-1d00-4ea3-bec2-186efe2ea74e" width="48%"/> </p>

---

<h2 align="center">Generate a Personalized README.md for Your Repository</h2> <p align="center"><i>Create a custom template to your project</i></p> <p align="center"> <img src="https://github.com/user-attachments/assets/085614d7-3b5f-42b8-8cb4-4e821937ef82" width="48%"/> <img src="https://github.com/user-attachments/assets/52b7ae01-62a2-486b-89cd-af5e55d67b4d" width="48%"/> </p>

---

<h2 align="center">Identify Unused Files & Imports with Issue Breakdown</h2> <p align="center"><i>Detect empty files, unused imports, and get a full overview of project issues</i></p> <p align="center"> <img src="https://github.com/user-attachments/assets/9ba1ed63-2809-41b5-94a3-9c8e8c25a50f" width="48%" /> <img src="https://github.com/user-attachments/assets/1ac36c69-7e68-4e93-af23-1c344b8de47a" width="48%" /> </p>

Overview

DevLens delivers comprehensive insights into your codebase, helping teams understand, document, and optimize their software projects with ease.

Key Features

• Language Breakdown: Visualize programming languages distribution (done)
• Code Metrics: Analyze lines of code and structural patterns (done)
• Dependency Mapping: Generate interactive graphs of module relationships (not yet)
• AI-Powered Documentation: Get summaries of files, functions, and classes (done)
• Dead Code Detection: Identify unused code to improve maintainability (done)
• README Generator: Create comprehensive documentation automatically (done)

DevLens CLI Commands

| Command | Description | Status | |---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | devlens summary PATH | Generates a comprehensive summary of the project, including total files, total lines, directory count, language breakdown, and project structure. | Done | | devlens analyse PATH | Uses meta-llama/llama-4-scout-17b-16e-instruct to analyze each file and provide a high-level summary of what it does. | Done | | devlens readme PATH | Automatically creates a professional README.md tailored to the project's structure and content. | Done | | devlens empty PATH | Scans the project and lists all empty files and a full file inventory. | Done | | devlens deadcode PATH | Detects unused functions across the repository to help clean up dead code. | Done | | devlens graph PATH | Visualizes module relationships and project architecture through interactive graphs. | Not yet |

---

Installation

Clone the repository:

git clone https://github.com/YounesBensafia/DevLens.git

Install from PyPI:

pip install devlens-cli

---

Add Devlens (uv tools) to PATH

To make devlens accessible from anywhere in the terminal:

1. Export the api key (set the environment variable GROQ_API_KEY with the value of the key you got from Groq):

export GROQ_API_KEY=your_real_api_key_here

2. Execute this command:

uv tool install .

3. After that, execute:

devlens --help

Troubleshooting

• If you have issues, please open an issue in the repository so we can help.

Note: Currently, the deadecode option is available for Python projects only.

DevLens is designed to help engineering teams understand complex codebases quickly and efficiently.

---