explain-repo

Generates a plain-English architecture briefing of an unfamiliar codebase by tracing call paths with CodeGraph.

1|Updated Jul 22, 2026
One-click install
npx skills add https://github.com/thititongumpun/skills --skill explain-repo-thititongumpun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: explain-repo
Source: https://github.com/thititongumpun/skills/tree/main/skills/explain-repo
Command: npx skills add https://github.com/thititongumpun/skills --skill explain-repo-thititongumpun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @colbymchenry/codegraph.

What problem does it solve? Onboarding to an unfamiliar codebase is slow and error-prone: READMEs are stale, and guessing at architecture leads to wrong assumptions. This Skill produces a trustworthy briefing — what the repo does, one diagram, its external dependencies, and an explicit list of what could not be determined — by tracing real call paths instead of guessing. ## Core Features & Use Cases - Call-path tracing via CodeGraph: Seeds from entrypoints found in manifests and config, then follows one real path end to end using the codegraph CLI, with a documented fallback to reading entrypoints when no index exists. - Structured five-section report: A plain-English summary, an architecture diagram (delegated to the archify skill or a mermaid fallback), a parts table with file:line citations, an external-services inventory with evidence, and a mandatory ❓ Unclear section. - Honesty-first rules: Read-only operation, file:line citations for structural claims, and anything inferred rather than read is listed as an open question instead of a fabricated answer. - Use Case: A developer joins a team and runs /explain-repo on a service they have never seen; they get a half-page briefing, a diagram, and a list of questions to ask the original authors. ## Quick Start Ask the AI to run /explain-repo on the current repository to get a plain-English architecture briefing with a diagram and a list of unknowns.

Frequently Asked Questions about explain-repo

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I understand what an unfamiliar repo does?

Run /explain-repo on the repository. It reads the README, manifests, and config first, traces one real call path from the entrypoint using CodeGraph, and produces a five-section briefing: summary, diagram, parts table, external services, and open questions.

How do I generate an architecture diagram from a codebase?

The skill hands the component list it builds during tracing to the archify skill, which writes a self-contained HTML+SVG architecture diagram. If archify is unavailable, it writes a mermaid flowchart directly into the report instead.

Does explain-repo work without CodeGraph installed?

Yes, with reduced depth. Without codegraph it falls back to reading entrypoints, manifests, and config files, and the report explicitly states that the map is shallower because no symbol graph was available.

Can explain-repo modify or fix the code it analyzes?

No. The skill is strictly read-only by design. It explains the codebase and never edits, refactors, or fixes anything while analyzing it.

Why does the report include an Unclear section?

The skill never fills gaps with plausible guesses, since an invented service or data flow is worse than a blank. Anything inferred rather than directly read is listed as a question in the ❓ Unclear section so the reader can verify it.