agentleFS
dominionthedevdominionthedev/skills/project-indexer/SKILL.md

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

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
  1. Distinctive:

    Use the index to navigate:

    line 58
  2. Distinctive:

    Start with entry points

    line 59
  3. Distinctive:

    Read dependencies for context

    line 61

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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-content

Step 2 — Parse the index output

The index gives you:

OutputUse it for
Project summaryKnow the scale and language mix
File treeUnderstand directory structure
Key filesFind entry points and configs
DependenciesUnderstand what libraries are in play
Code mapSee 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 + PostgreSQL

What 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.py

Requires 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 3

Include file contents

For deeper analysis:

python index.py . --include-content

JSON output

For programmatic use:

python index.py . --json

NOTE: merge this skill into the codebase-radar skill and delete this skill

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.