index

Scan codebases and update Markdown documentation with directory trees and dependency diagrams.

1|Updated Jan 11, 2026
One-click install
npx skills add https://github.com/YH-05/finance --skill index-yh-05
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index
Source: https://github.com/YH-05/finance/tree/main/.claude/skills/index
Command: npx skills add https://github.com/YH-05/finance --skill index-yh-05

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automatically updates project documentation, including commands, skills, agents, directory structures, and dependency diagrams, ensuring your project's reference materials are always accurate and reflecting the latest codebase.

Core Features & Use Cases

  • Automated Documentation Updates: Scans the project to detect new commands, skills, and agents, then updates relevant Markdown files.
  • Directory Structure Visualization: Generates and maintains an up-to-date directory tree in CLAUDE.md and README.md.
  • Dependency Graph Generation: Creates visual dependency diagrams (Mermaid format) for Python packages and command-skill-agent relationships.
  • Use Case: After adding a new skill or command, simply run /index --update to automatically refresh all related documentation, saving manual effort and preventing outdated information.

Quick Start

Run the index skill with the update flag to refresh all project documentation.

Frequently Asked Questions about index

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

FAQPage Schema
How do I automatically update project documentation to match code changes?

To automatically update project documentation, you can run an index command that scans the codebase using glob patterns and file parsing to synchronize reference files like CLAUDE.md and README.md with the latest directory structures and commands.

What is the best way to generate a dependency graph for a Python project?

Generating a dependency graph for a Python project is done by scanning the codebase to identify package relationships and rendering them as visual dependency diagrams in Mermaid format within your documentation files.

How do I keep my directory structure visualization current in Markdown files?

Keeping your directory structure visualization current involves scanning the project file system and automatically regenerating the directory tree in Markdown files like CLAUDE.md and README.md to reflect the latest codebase state.

Does automated documentation generation work for tracking new commands and skills?

Automated documentation generation does work for tracking new commands and skills by scanning the project to detect additions and then updating relevant reference materials to ensure the project documentation stays synchronized.

What are the limitations of using glob patterns for codebase documentation scanning?

Using glob patterns for codebase documentation scanning is limited by the specific file parsing rules applied, meaning it relies on consistent file system access and predefined patterns to accurately detect commands, skills, and agents without missing non-standard structures.