code-module

Generate a tree-structured modules.md with per-directory function summaries.

Updated Jan 22, 2026
One-click install
npx skills add https://github.com/NightmareZero/myAgSkills --skill code-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-module
Source: https://github.com/NightmareZero/myAgSkills/tree/main/code-module
Command: npx skills add https://github.com/NightmareZero/myAgSkills --skill code-module

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Quickly understand large codebases by producing a tree-structured module overview with concise function summaries for each directory.

Core Features & Use Cases

  • Builds a hierarchical directory tree (root to leaves) for codebases.
  • Generates modules.md with per-directory summaries and a leaf-to-root propagation workflow.
  • Validates coverage and updates descriptions in batches to ensure complete documentation.

Quick Start

Automatically generate a hierarchical modules.md documenting codebase structure and leaf-level functionality when you say "init-modules".

Frequently Asked Questions about code-module

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

FAQPage Schema
How do I generate a hierarchical module overview for my codebase?

Generate a tree-structured module overview by triggering the init-modules command, which builds a hierarchical directory tree and produces a modules.md file containing concise function summaries for each directory in your codebase.

What is the best way to document project structure automatically?

The best way is to use an automated leaf-to-root propagation workflow that creates a structural skeleton, populates descriptions incrementally, and validates coverage to ensure every directory has a meaningful description in markdown.

Can I create a markdown tree view with function summaries for large projects?

Yes, you can create a markdown tree view for large projects by generating a hierarchical modules.md document that provides per-directory summaries and validates complete coverage across the entire codebase structure.

How does leaf-to-root propagation work for codebase documentation?

Leaf-to-root propagation works by generating concise summaries for leaf directories first, then incrementally propagating these descriptions upward to parent directories to build a complete hierarchical overview.

Does generating a module overview require external dependencies?

Generating a module overview requires no external dependencies, allowing you to directly analyze your codebase structure and output a tree-structured markdown document with directory-level summaries.

When should I avoid using automated tree-structure documentation?

You should avoid using automated tree-structure documentation if your project lacks distinct functional modules, as the validation process enforces meaningful descriptions for every single directory in the codebase.