indexer

Scan a project root and write INDEX.md with file purposes and navigation guidance.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/zerwiz/wayofpi --skill indexer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: indexer
Source: https://github.com/zerwiz/wayofpi/tree/main/.pi/skills/indexer
Command: npx skills add https://github.com/zerwiz/wayofpi --skill indexer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the guesswork of understanding a repository by creating a clear project index that explains what each important file and directory does.

Core Features & Use Cases

  • Directory Mapping: Scans a project root and organizes the structure into an easy-to-follow reference.
  • File Purpose Summaries: Adds concise explanations for important files so agents and humans can quickly find what matters.
  • Onboarding and Refactors: Helps during project handoff, large refactors, and repository audits by providing a single source of navigation truth.

Quick Start

Use the indexer skill to scan the chosen project root and write an INDEX.md file that summarizes the directory structure and important file purposes.

Frequently Asked Questions about indexer

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

FAQPage Schema
How do I create a codebase map for project onboarding?

To create a codebase map for project onboarding, scan the project root to discover the directory tree, summarize key file purposes, and write an INDEX.md file. This generates a concise navigation guide for agents and humans.

What is the best way to generate file summaries for a repository audit?

Generating file summaries for a repository audit involves scanning the project structure and extracting concise explanations of important files. The output is written into an INDEX.md file, providing a single source of navigation truth.

How do I document directory structure for a repository handoff?

Documenting directory structure for a repository handoff requires mapping the project root and organizing it into an easy-to-follow reference. The process outputs an INDEX.md file containing directory mappings and file purpose summaries.

Can I use an indexing approach for large refactors?

Yes, an indexing approach works for large refactors by providing a root-level map of the codebase. It scans the project tree and summarizes important files, helping you navigate complex structural changes during refactoring.

What does a project navigation guide include?

A project navigation guide includes a mapped directory structure and concise file purpose summaries. It organizes the project root into an easy-to-follow reference written within an INDEX.md file for quick navigation.

Do I need specific dependencies to build a project index?

No specific dependencies are required to build a project index. The process relies on discovering the existing directory tree, summarizing key files, and writing the navigation guidance directly into an INDEX.md file.