project-index-reader

Scans PROJECT_INDEX.md files in local repositories to find relevant code references before implementation.

3|1|Updated Apr 14, 2026
One-click install
npx skills add https://github.com/ZHLX2005/sl --skill project-index-reader-zhlx2005
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-index-reader
Source: https://github.com/ZHLX2005/sl/tree/main/skills/project-index-reader
Command: npx skills add https://github.com/ZHLX2005/sl --skill project-index-reader-zhlx2005

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When implementing a new feature, developers often start coding from scratch without checking whether similar solutions already exist in their local repositories. This Skill enforces a read-first workflow: it scans project indexes under .claude/repo/ to locate relevant existing code examples before any implementation begins. ## Core Features & Use Cases - Index Scanning: Lists and quickly scans PROJECT_INDEX.md files across all repositories under .claude/repo/ to identify candidate projects. - Relevance Filtering: Reads the index of candidate projects and decides whether to dive into source code based on module and feature descriptions. - Guided Code Search: Falls back to Grep and Glob searches (e.g., for UI patterns like glassmorphism) when the index alone is insufficient. - Use Case: Before building a blur-effect UI component, the Skill scans all indexed repositories, finds a project with a similar module, reads its source code, and only then allows implementation to begin. ## Quick Start Before implementing this feature, scan the PROJECT_INDEX.md files under .claude/repo/ and show me any relevant existing code examples.

Frequently Asked Questions about project-index-reader

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

FAQPage Schema
How do I find relevant code examples before implementing a feature?

Scan the PROJECT_INDEX.md files under .claude/repo/ to review project names, core modules, and feature descriptions. When an index shows a directly related module, read that project's source code before writing any new code.

What is PROJECT_INDEX.md and how is it used?

PROJECT_INDEX.md is a per-repository index file listing the project name, core modules, and feature descriptions. The Skill reads it to quickly judge relevance, optionally loading PROJECT_INDEX.json for more detail before diving into source files.

Does this Skill work with repositories outside .claude/repo/?

No. The Skill explicitly applies only to repositories located under the .claude/repo/ directory. Repositories stored elsewhere are not scanned or indexed by this workflow.

What happens if the project index has no relevant information?

If the index shows no related modules, the project is skipped. When indexes are insufficient overall, the Skill falls back to Grep keyword searches and Glob file patterns to locate candidate source code directly.

When should I not use this index-scanning workflow?

Skip it for simple file operations or when the user has already specified a single target file. The workflow is designed for feature implementation, reference learning, and case-finding scenarios.