devlens-tool 0.1.0

A cli tool to help developers understand and manage their codebases.

DevLens

How to Use It

Quick guide to start analyzing your codebase

---

Illuminate Your Codebase with Powerful Analysis

AI-powered insights & detailed statistics for your repository

---

Complete Codebase Insights

Total files, lines of code, directories, language breakdown, and detailed project structure

---

Generate a Personalized README.md for Your Repository

Create a custom template to your project

---

Identify Unused Files & Imports with Issue Breakdown

Detect empty files, unused imports, and get a full overview of project issues

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.

---