explain-codebase
Installation
SKILL.md
Explain Codebase Skill
When explaining a codebase, follow this structured process. The goal is to give someone everything they need to understand the project and start contributing confidently.
1. Discovery — Scan the Project
Before explaining anything, gather information:
Project Identity
# What is this project?
cat README.md 2>/dev/null
cat package.json 2>/dev/null | grep -E '"name"|"description"|"version"'
cat pyproject.toml 2>/dev/null | head -20
cat Cargo.toml 2>/dev/null | head -20
cat go.mod 2>/dev/null | head -5
cat pom.xml 2>/dev/null | head -30
cat Gemfile 2>/dev/null | head -10
cat composer.json 2>/dev/null | grep -E '"name"|"description"'