bmad-index-docs

Generates an index.md file cataloging all documents in a target folder.

Updated Mar 20, 2026
One-click install
npx skills add https://github.com/LinCie/bearuang --skill bmad-index-docs-lincie
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/LinCie/bearuang/tree/main/.opencode/skills/bmad-index-docs
Command: npx skills add https://github.com/LinCie/bearuang --skill bmad-index-docs-lincie

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Navigating folders full of documentation becomes difficult when there is no central overview of what each file contains. This Skill scans a target directory and produces a structured index.md with organized links and concise descriptions of every file. ## Core Features & Use Cases - Directory Scanning: Lists all files and subdirectories in a target location, skipping hidden files by default. - Content-Based Descriptions: Reads each file to write accurate 3-10 word descriptions rather than guessing from filenames. - Organized Markdown Output: Groups files by type or subdirectory, sorts alphabetically, and uses relative links starting with ./. - Use Case: After adding several new guides to a project's docs folder, ask the Skill to regenerate index.md so every document is linked and described in one place. ## Quick Start Create an index of all files in the docs folder with brief descriptions of each document.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I create an index of all files in a folder?▼

Point the Skill at the target directory and it scans all files and subdirectories, reads each file's content, and writes an index.md with organized links and 3-10 word descriptions. Files are grouped by type or subfolder and sorted alphabetically.

How to generate a documentation index for a project docs folder?▼

Request an index for your docs folder and the Skill produces a Markdown file listing every document with relative links starting with ./ and concise descriptions based on actual file contents, not just filenames.

Does the index include hidden files or dotfiles?▼

No, hidden files starting with a dot are skipped by default. They are only included if you explicitly specify that they should be part of the index.

Why does index generation fail for some directories?▼

Generation halts if the target directory does not exist, is inaccessible, or if you lack write permissions to create index.md in that location. Verify the path exists and permissions are correct before retrying.

Can I update an existing index.md instead of creating a new one?▼

Yes, the Skill handles both creating a new index.md and updating an existing one. It rescans the folder contents and refreshes the listings to reflect added, removed, or changed files.