/explain-codebase

Description

Scan the whole codebase and explain it to me in an easy way that allows me to understand how it functions and how everything is connected

AI Summary

Scans your entire codebase to provide a clear, high-level explanation of what the project does, how it's organized, and how components connect. Use this when joining a new project or trying to understand an unfamiliar codebase structure.

Install

Add the repository(one-time)

/plugin marketplace add kriscard/kriscard-claude-plugins

Install the plugin

/plugin install architecture@kriscard

Command Content

Explain Codebase

Scan the codebase and provide a clear, accessible explanation of:

How It Works

What does this project do?
- Main purpose in plain language
- Key features and capabilities
How is it organized?
- Main folders and what they contain
- Entry points (where execution starts)
How do the pieces connect?
- Data flow from user action to result
- Key integrations between components
What are the most important files?
- Core business logic locations
- Configuration files that matter

Output Format

Use simple language, avoid jargon
Include a high-level diagram if helpful
Point out non-obvious connections
Highlight patterns used

Make it easy for someone new to understand the codebase structure and how everything fits together.

Links

GitHub Stats

0 forks

Updated 3 days ago