Skip to main content

CLI tool to analyze and explain codebases

Project description

Codebase Explainer

A production-ready CLI tool to analyze, explain, and audit codebases.

Features

  • Architecture Analysis: High-level overview of the project structure.
  • Dependency Mapping: Visualize how files import each other.
  • Call Graph: Trace function calls across the entire project.
  • Endpoint Detection: Automatically find Flask, FastAPI, and Express routes.
  • Gemini Integration: Uses the gemini CLI for intelligent code explanations.
  • HTML Reports: Generates a beautiful, interactive report.

Installation

Via Pip

pip install .

Via Docker

docker build -t code-explainer .

Usage

Analyze a codebase

code-explainer analyze .

Explain a specific file

code-explainer explain path/to/file.py

Audit for issues

code-explainer audit .

List endpoints

code-explainer endpoints .

Run via Docker

docker run -v $(pwd):/app code-explainer analyze /app

Requirements

  • Python 3.7+
  • gemini CLI (system-installed) for LLM features.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codebase_explainer-0.1.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codebase_explainer-0.1.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file codebase_explainer-0.1.0.tar.gz.

File metadata

  • Download URL: codebase_explainer-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for codebase_explainer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b9da6c47359b557ef82f653979fb69f8dd369891994c17429c3a8092ce421270
MD5 bb5d25747d234a5132e68ade841e5d7f
BLAKE2b-256 13787559a30510067f2d1dc7b7532e66f52986a4dd3af4a363ff2bc909a6599d

See more details on using hashes here.

File details

Details for the file codebase_explainer-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for codebase_explainer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1348107a9e2594a6637e9a63014a474ef3081c58a9690bfeed24c1406ea4b90
MD5 f1e9ca6ade75255cc8c3961f8104e8a4
BLAKE2b-256 662546456f3df439ad11f9b941cdc3ab6691562b9a35d9891a7905e292d191b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page