dir-to-filelist

Scan directories recursively and generate a grouped Markdown file listing file paths.

Updated May 3, 2026
One-click install
npx skills add https://github.com/wanyusheng63-alt/vocab-learn --skill dir-to-filelist
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dir-to-filelist
Source: https://github.com/wanyusheng63-alt/vocab-learn/tree/main/.codebuddy/skills/dir-to-filelist
Command: npx skills add https://github.com/wanyusheng63-alt/vocab-learn --skill dir-to-filelist

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Scans directories to automatically generate a Markdown-list inventory of files, including their paths, to replace manual cataloging.

Core Features & Use Cases

  • Recursive directory scanning that traverses subfolders while skipping hidden files and directories.
  • Exclusion support via --exclude-dir and --exclude-file to tailor the inventory.
  • Output generation producing a structured Markdown "Asset List" that groups files by their immediate subdirectory.
  • Use cases include preparing asset inventories for handoffs, documenting project files for audits, and creating deployment-ready file lists.

Quick Start

Run the script to scan a directory and generate a Markdown file listing all files with their paths.

Frequently Asked Questions about dir-to-filelist

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

FAQPage Schema
How do I generate a Markdown file inventory from a directory automatically?

To generate a Markdown file inventory from a directory automatically, use a Python script that recursively scans the target path and outputs a structured list of files with their paths. It groups files by their immediate subdirectory for easy readability.

Can I exclude specific files and folders when scanning directories for an asset list?

Yes, you can exclude specific files and folders when scanning directories for an asset list by using the --exclude-dir and --exclude-file filters. This allows you to tailor the generated inventory to only include relevant project files.

What is directory scanning used for in project documentation and asset handoffs?

Directory scanning for project documentation and asset handoffs is used to replace manual cataloging by automatically producing a human-readable list. It creates deployment-ready file lists and categorized asset inventories with full file paths.

Does the directory scan script process hidden files and subdirectories?

No, the directory scan script does not process hidden files and subdirectories. It traverses visible folders recursively while automatically skipping any hidden entries to ensure the generated Markdown inventory remains clean and relevant.

Best way to create a deployment-ready file list from a local project folder?

The best way to create a deployment-ready file list from a local project folder is running an automated directory scan that produces a structured Markdown asset list. This approach groups files by subdirectory and supports custom exclusion filters for targeted output.