project-indexer
Skill1 starsChanged 6 months agoMITView on GitHub
Create and manage project indexes for fast codebase understanding and navigation. Use this skill whenever the user wants to index a project, build a knowledge base of their codebase, scan a repository structure, or get a quick overview of a project's organization. ALWAYS run the index script FIRST before exploring individual files. Also use when debugging, navigating unfamiliar code, or when the user mentions "index", "scan", "map", "overview", or "summary" of a codebase.
3 other projects use a version of this.
Adopted by
Most recently taken up by
- hamzaabduljabbar/construction-claude-cowork-project-indexertheir own version, first seen May 19, 2026
- xdrshjr/JR-OpenClaw-Skillstheir own version, first seen Feb 3, 2026
- scott2b/claude-skillstheir own version, first seen Oct 17, 2025
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- hamzaabduljabbar/construction-claude-cowork-project-indexer★ 9same name
- scott2b/claude-skills★ 1same name
- xdrshjr/JR-OpenClaw-Skills★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository5 other files it gives its agents.
- advanced-codingSkill
- codebase-radarSkill
- extended-frontendSkill
- project-forgeSkill
- ruthless-mentorSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 58
Use the index to navigate:
- Distinctive: line 59
Start with entry points
- Distinctive: line 61
Read dependencies for context
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Project Indexer — Fast Codebase Mapping
You create project indexes that enable instant codebase understanding. This is your first move when working with any existing project or when the user wants to understand a codebase quickly.
The Golden Rule
Never start reading files one by one. Run the indexer first.
The index script gives you architecture, file map, dependencies, and entry points in under a second. That context makes every subsequent file read 10x more meaningful.
Workflow
Step 1 — Run the index script
python skills/project-indexer/scripts/index.py <path> [--depth 6] [--include-content]# Examples
python index.py /path/to/project
python index.py . --depth 4
python index.py ~/projects/my-app --include-contentStep 2 — Parse the index output
The index gives you:
| Output | Use it for |
| Project summary | Know the scale and language mix |
| File tree | Understand directory structure |
| Key files | Find entry points and configs |
| Dependencies | Understand what libraries are in play |
| Code map | See class/function locations |
Step 3 — Targeted exploration
Use the index to navigate:
- Start with entry points
- Focus on relevant domains from the file tree
- Read dependencies for context
Step 4 — Begin the task
Armed with full context, complete the user's request efficiently.
Output Reference
Project: my-app
----------------
Files: 142 | Lines: 18,420 | Language: TypeScript
Directory Structure:
├── src/
│ ├── app/ (34 files) - Application entry points
│ ├── components/ (28 files) - UI components
│ └── lib/ (15 files) - Shared utilities
├── tests/ (18 files) - Test suite
└── config/ (6 files) - Configuration files
Key Files:
- src/app/layout.tsx (main layout)
- src/app/page.tsx (homepage)
- src/lib/auth.ts (auth utilities, 480 lines)
Dependencies:
- Next.js, React, Tailwind CSS
- Prisma, PostgreSQL
- Jest, Testing Library
Tech Stack:
- Framework: Next.js
- Language: TypeScript
- Styles: Tailwind CSS
- Database: Prisma + PostgreSQLWhat the indexer detects
Languages: TypeScript, JavaScript, Python, Go, Rust, Java, C++, C#, Swift, Kotlin, Ruby, PHP, SQL, Dart, HTML/CSS
Frameworks & Tools:
- Frontend: React, Vue, Angular, Next.js, Svelte, Astro, Flutter
- Backend: Express, FastAPI, Django, Flask, Spring, Gin, Fiber
- Database: PostgreSQL, MySQL, MongoDB, Redis, SQLite
- Build: Webpack, Vite, Rollup, Babel, TypeScript
Patterns:
- API routes and endpoints
- Database models and schemas
- Component structures
- Utility functions
- Test organization
Script location
skills/project-indexer/scripts/index.pyRequires Python 3.10+ stdlib only. Runs in < 1 second on most codebases.
Advanced Usage
Custom depth
Limit recursion depth for large monorepos:
python index.py . --depth 3Include file contents
For deeper analysis:
python index.py . --include-contentJSON output
For programmatic use:
python index.py . --jsonNOTE: merge this skill into the codebase-radar skill and delete this skill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

