skills.rest
Stephensmetana
StephensmetanaCOMMUNITY
Explore all skills by this author →
GitHub

directory-scanner

Scan a target directory and return structured JSON of subdirectories, file counts, and README excerpts.

Updated Apr 28, 2026
Search Tags:#audit#structure#README#directory#report#scan#file-types
One-click install
npx skills add https://github.com/Stephensmetana/skill-scrolls --skill directory-scanner
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: directory-scanner
Source: https://github.com/Stephensmetana/skill-scrolls/tree/main/utilities/directory-scanner
Command: npx skills add https://github.com/Stephensmetana/skill-scrolls --skill directory-scanner

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Quickly understand a folder's layout by enumerating immediate subdirectories, counting files, listing top-level items, and surfacing notable files and README excerpts to give a fast mental model of the structure.

Core Features & Use Cases

  • Generate a concise Markdown directory report with per-subdirectory purpose, file inventory, notable files, and README excerpt.
  • Optional depth-limited scanning and top-level file exposure to help audits, documentation, and project onboarding.
  • Output can be consumed by humans or fed into automation to drive documentation or validation activities.

Quick Start

Run the scan_dir.py tool against a target directory to generate the directory report.

Frequently Asked Questions about directory-scanner

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

FAQPage Schema
How do I generate a directory structure report for a project folder?▼

A directory structure report provides per-subdirectory purpose, file inventory, and README excerpts. You generate it by running the scan_dir.py script against a target folder to audit project layouts and accelerate onboarding.

Can I limit the depth of a file scan when auditing a large folder?▼

Yes, depth-limited scanning is supported. You can configure the scan depth to count files and record extensions only to a certain level, preventing excessive traversal when auditing large project layouts.

What is the best way to document folder structures for new developers?▼

The best way to document folder structures is to generate a concise Markdown report that surfaces immediate subdirectories, notable files, and README excerpts. This gives new developers a fast mental model of the project layout.

Does the directory scanner output JSON for downstream automation?▼

Yes, the directory scanner returns a structured JSON payload containing file counts, types, and notable files. This output is suitable for feeding into downstream automation to drive documentation or validation activities.

Are there limitations when scanning directories with no README files?▼

When scanning directories with no README files, the tool omits the README excerpt from the report. It will still count files, record extensions, and list top-level items to provide a structural overview of the folder.

Related Skills

Explore More Software Engineering Skills→
ArianHobson333ArianHobson333
7

path-traversal

Detect directory and archive traversal vulnerabilities in filesystem operations.

Community
Intermediate
vinnie357vinnie357
24

nushell

Process structured data like JSON and CSV in Nushell pipelines.

Community
Intermediate
zephyrwang6zephyrwang6
333

mem-file-scan

Scan weekly Obsidian Markdown changes and propose L1 recording candidates.

Community
Basic
OpenAuthorityOpenAuthority
8

list_dir

List directory contents with optional recursive traversal and relative paths.

Official
Intermediate