Skip to content

AI-powered code explanation tool with exploration queue for just-in-time codebase education

Notifications You must be signed in to change notification settings

benthomasson/code-explainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

code-explainer

AI-powered code explanation tool for onboarding onto unfamiliar codebases.

Install

uv tool install git+https://github.com/benthomasson/code-explainer

Usage

# Explain a repository's architecture
explain repo ~/git/some-project

# Explain a specific file
explain file src/auth/client.py

# Explain a specific function or class
explain function src/auth/client.py:login

# Explain a diff
explain diff -b feature-branch --base main

Options

  • --model/-m: Model to use (default: claude)
  • --output-dir/-d: Output directory (default: ./explanations/)
  • --repo/-r: Repository path (default: cwd)

About

AI-powered code explanation tool with exploration queue for just-in-time codebase education

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages