skills.rest
sakebomb
sakebombCOMMUNITY
Explore all skills by this author →
𝕏@SakebombGitHub

index

Generate a PROJECT_INDEX.md mapping the codebase structure and key files.

2|Updated Feb 13, 2026
Search Tags:#documentation#indexing#codebase#structure#session-management#project-index
One-click install
npx skills add https://github.com/sakebomb/scaffold --skill index-sakebomb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: index
Source: https://github.com/sakebomb/scaffold/tree/main/.claude/skills/index
Command: npx skills add https://github.com/sakebomb/scaffold --skill index-sakebomb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a PROJECT_INDEX.md at the project root that maps the entire codebase for fast session orientation. This eliminates the need to have Claude rediscover project structure each session.

Core Features & Use Cases

  • Build a concise ASCII tree of the top-level project layout (two levels deep) with purpose annotations for major directories.
  • List entry points, main executables, CLI commands, and API routes or server startup points.
  • Capture dependencies, configuration files, tests, and link to architectural decisions and lessons.

Quick Start

Execute the /index command to generate or refresh PROJECT_INDEX.md at the project root.

Frequently Asked Questions about index

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

FAQPage Schema
How do I generate a codebase index for fast session orientation?▼

To generate a codebase index, execute the /index command at your project root. It creates a PROJECT_INDEX.md file mapping the entire project structure, eliminating the need to rediscover the layout each session.

What is the best way to map project structure and entry points for a new session?▼

Mapping project structure is done by generating a PROJECT_INDEX.md file. It builds a concise ASCII tree of the top-level layout, lists entry points, executables, and API routes to orient new sessions quickly.

When should I update my project index file?▼

You should update your project index at project start, after significant structural changes, or when executing the /index command with an update argument, ensuring the codebase map reflects current modules and dependencies.

Does generating a project-wide code index require any external dependencies?▼

Generating a project-wide code index requires no external dependencies. It operates standalone to scan the directory structure, identify configuration files, and document key architectural decisions directly into a markdown file.

What information does a project index capture about my codebase?▼

A project index captures an overview, directory structure, entry points, modules, configuration, tests, dependencies, and key architectural decisions. It provides a comprehensive map for fast session orientation.

Related Skills

Explore More Software Engineering Skills→
wgordon17wgordon17

index-repo

Generate a PROJECT_INDEX.md by scanning repository structure with parallel glob scans.

Community
Advanced
abdullah1854abdullah1854
1

codebase-navigation

Map codebase structure, dependencies, and architectural patterns.

Community
Intermediate
SkillPanelSkillPanel
199

docs-manager

Manage project documentation and standards in the .maister/docs/ repository.

Official
Advanced
11547613341154761334

project-overview

Analyze project directories to document structure, components, and architecture.

Community
Basic