summary-my-repo

Generates internal repository summary packs with architecture maps and code-backed evidence snippets.

3|Updated Mar 20, 2026
One-click install
npx skills add https://github.com/ceasarXuu/AstartesSkills --skill summary-my-repo-ceasarxuu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: summary-my-repo
Source: https://github.com/ceasarXuu/AstartesSkills/tree/main/skills/summary-my-repo
Command: npx skills add https://github.com/ceasarXuu/AstartesSkills --skill summary-my-repo-ceasarxuu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New collaborators struggle to understand an unfamiliar repository quickly, and shallow directory listings fail to explain how the code actually works. This Skill produces a dense, evidence-backed markdown summary pack that captures architecture, directory responsibilities, and core logic paths. ## Core Features & Use Cases - Architecture & Directory Mapping: Produces an annotated directory map explaining responsibility boundaries, not just a tree dump. - Core Logic Walkthroughs: Explains critical files, workflows, inputs, outputs, and invariants with step-by-step control flow summaries. - Code Evidence Layer: Requires every core claim to be backed by snippets with file paths, line ranges, and interpretations, separating implemented, inferred, planned, and risk items. - Use Case: When onboarding a new engineer to a project, run this Skill to generate a versioned summary pack under summary-my-repo/YYYY-MM-DD-vN/ containing overview, directory map, core logic, and code evidence files. ## Quick Start Ask the agent to read this repository and write a summary pack explaining its architecture and core logic with code evidence snippets into the summary-my-repo output folder.

Frequently Asked Questions about summary-my-repo

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

FAQPage Schema
How do I generate a repository summary for new team members?

Run this Skill against the repository root and it writes a markdown pack covering architecture, directory responsibilities, core workflows, and code evidence. Output goes to a versioned folder like summary-my-repo/YYYY-MM-DD-v1/ with four structured files.

What files does a repository summary pack contain?

The pack contains 00-overview.md for context and architecture, 01-directory-map.md for annotated structure, 02-core-logic.md for workflow walkthroughs, and 03-code-evidence.md for code snippets proving each claim.

How does the summary prove its architecture claims?

Every core workflow claim must reference at least one code snippet with a repository-relative file path and line range. Snippets are kept to 8-40 focused lines and include a one-sentence claim plus a short interpretation.

When should I not use a repository summary generator?

Avoid it for outward-facing product packaging, investor messaging, or GTM framing, and for simple code reviews or bug fixes. It also cannot produce reliable output when the repository is too incomplete to identify core logic from evidence.

How does versioning work for repeated summary runs?

Each run writes to summary-my-repo/YYYY-MM-DD-vN/ using the current local date. If a folder for that date already exists, the version increments from v1 to v2, v3, and so on, preserving earlier packs.