index-docs

Generate or update an index.md file for documents in a specified directory.

Updated Jan 29, 2026
One-click install
npx skills add https://github.com/GuidoBergman/aegish --skill index-docs-guidobergman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index-docs
Source: https://github.com/GuidoBergman/aegish/tree/main/.claude/skills/index-docs
Command: npx skills add https://github.com/GuidoBergman/aegish --skill index-docs-guidobergman

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation and updating of an index file for all documents within a specified directory, making your knowledge base easily searchable.

Core Features & Use Cases

  • Document Indexing: Generates or updates an index.md file.
  • Directory Scanning: Recursively scans a given directory for documents.
  • Use Case: Keep your project's documentation organized and searchable by automatically updating an index whenever new documents are added or modified.

Quick Start

Use the index-docs skill to create an index for all documents in the '~/my-project/docs' directory.

Frequently Asked Questions about index-docs

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

FAQPage Schema
How do I create a searchable index for all documents in a project directory?

To create a searchable document index, this skill recursively scans your specified directory and automatically generates an index.md file that catalogs all project-related files for easy retrieval.

How does directory scanning work for organizing project documentation?

Directory scanning for documentation organization works by recursively traversing a given directory path to locate all documents, then compiling their details into a centralized index file for knowledge management.

Can I automatically update my document index when new files are added?

Yes, you can automatically update your document index by running the indexing operation whenever new documents are added or modified, ensuring your knowledge base remains accurately cataloged and searchable.

What's the best way to catalog project files for knowledge management without manual effort?

Using an automated indexing script is the best way to catalog project files for knowledge management, as it eliminates manual effort by scanning your directory and generating a structured index file.

Do I need any specific dependencies to generate a markdown index file for my docs?

No specific dependencies are required to generate a markdown index file, but you do need a task execution mechanism within your environment to perform the directory scanning and indexing operation.