bmad-index-docs

Generate an index.md file listing all documents in a specified folder.

Updated Dec 26, 2025
One-click install
npx skills add https://github.com/tiween/tiween --skill bmad-index-docs-tiween
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/tiween/tiween/tree/main/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/tiween/tiween --skill bmad-index-docs-tiween

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation or updating of an index.md file, which references all documents within a specified folder, reducing the manual effort of maintaining a directory list.

Core Features & Use Cases

  • Index Generation: Automatically generates or updates an index.md file that lists all documents in a folder.
  • User Requested Index: Useful when a user needs to create or update an index of all files in a specific folder.
  • Use Case: For example, if you have a folder of technical documents and you want to quickly reference them, this Skill can create an index for you.

Quick Start

Generate an index for the 'documents' folder using the bmad-index-docs skill.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I automatically generate an index file for a folder of documents?

To automatically generate an index file for a folder of documents, this Skill scans a specified directory and writes an index.md file listing all contained files. It reduces manual effort by creating the directory list automatically.

Can I automatically generate descriptions for files when creating a folder index?

Yes, you can generate descriptions for files when creating a folder index. This Skill analyzes file content within the specified folder to automatically generate relevant descriptions for each document entry in the output index.md file.

What is the best way to update an existing index.md file for a document folder?

The best way to update an existing index.md file for a document folder is to run this Skill on the target directory. It automates the update process, rewriting the index to reference all current documents and their generated descriptions.

Do I need write permissions to generate an index for a specific folder?

Yes, you need write permissions to generate an index for a specific folder. This Skill requires access to the target directory and write permissions to successfully save the generated index.md file in the specified location.

Why use an automated folder indexing tool for technical documents?

You use an automated folder indexing tool for technical documents to quickly reference files without manual maintenance. It solves the problem of manually tracking and listing multiple documents within a growing directory.