project-multilevel-index

🥈Silver

The project-multilevel-index is a powerful documentation system that auto-maintains code indexes, file headers, and dependency graphs. Inspired by GEB, it enhances productivity for developers using Claude Code and various IDE extensions.

9240Updated 2w ago

Intermediate15 minutes to implementdevelopment

Saves ~120 min per use

Quick InstallView Source

claude install Claudate/project-multilevel-index

Works with:

ClaudeCursorWindsurfVS Code

Overview

About This Skill

How to Use

[{"step":"Install the project-multilevel-index tool. Run `npm install -g project-multilevel-index` or use your IDE's extension marketplace (e.g., VS Code extension 'Project Indexer').","tip":"Ensure your project has a `.git` directory or initialize one with `git init` if it doesn't exist. The tool uses Git history to track file modifications."},{"step":"Run the tool on your project root. Execute `project-index --project acme-ecommerce --language js` in your terminal or trigger the command from your IDE's command palette.","tip":"For large projects, add `--depth 3` to limit the directory depth and avoid overwhelming output. Example: `project-index --project acme-ecommerce --language js --depth 3`."},{"step":"Review the generated index. The tool outputs a structured markdown file (e.g., `ACME_ECOMMERCE_INDEX.md`) in your project root. Open it in your preferred editor.","tip":"Use the `diff` feature in your IDE to compare the new index with the previous version. This helps identify unintended changes or missing files."},{"step":"Integrate with your CI/CD pipeline. Add a step in your GitHub Actions or GitLab CI to regenerate the index on every push to `main` branch. Example:\n```yaml\n- name: Generate Project Index\n run: project-index --project acme-ecommerce --language js --output docs/index.md\n```","tip":"Set up a pre-commit hook to validate the index before commits. Use `project-index --validate` to ensure no files are missing or misclassified."},{"step":"Share the index with your team. The markdown file can be committed to your repository or hosted as part of your project documentation (e.g., GitHub Wiki).","tip":"For teams using Productiv (finance tool), link the project index to your SaaS spending data by referencing the project name in Productiv's dashboard. This helps correlate development effort with software costs."}]

Use Cases

Automatically generate and maintain code documentation

Visualize project dependencies for better management

Integrate with IDEs for seamless development workflows

Enhance collaboration through self-referential documentation

Best For

GrowthRevOps

Setup & Installation

Quick Install

Terminal

claude install Claudate/project-multilevel-index

Alternative Install (Git Clone)

git clone https://github.com/Claudate/project-multilevel-index

Requirements

Claude Code or compatible AI agent
Works with: Claude, Cursor, Windsurf, VS Code

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Generate a multilevel project index for [PROJECT_NAME] using the project-multilevel-index system. Include: (1) a hierarchical directory structure with file paths and descriptions, (2) auto-generated file headers for [LANGUAGE] with metadata like author, version, and last modified date, and (3) a dependency graph showing module relationships. Use [TOOL_NAME] if available to automate this process.

Example Output

```
# Project: Acme E-Commerce Platform

## 1. Directory Structure

```
acme-ecommerce/
├── src/
│   ├── api/
│   │   ├── controllers/
│   │   │   ├── auth.controller.js (User authentication endpoints)
│   │   │   └── product.controller.js (Product CRUD operations)
│   │   ├── models/
│   │   │   └── user.model.js (Mongoose schema for users)
│   │   └── routes/
│   │       ├── auth.routes.js (Authentication endpoints)
│   │       └── product.routes.js (Product-related routes)
│   ├── services/
│   │   ├── payment.service.js (Stripe integration)
│   │   └── email.service.js (Nodemailer for notifications)
│   └── utils/
│       └── logger.js (Winston logger configuration)
├── tests/
│   ├── unit/
│   │   └── auth.test.js (Jest tests for auth controller)
│   └── integration/
│       └── product.test.js (Integration tests for product API)
└── config/
    └── database.js (MongoDB connection setup)
```

## 2. File Headers

```javascript
// File: src/api/models/user.model.js
// Description: Mongoose schema for user data
// Language: JavaScript
// Author: Jane Doe (jane.doe@acme.com)
// Version: 2.1.0
// Last Modified: 2023-11-15
// Dependencies: mongoose@7.4.3, bcrypt@5.1.0
```

```javascript
// File: src/services/payment.service.js
// Description: Handles Stripe payment processing
// Language: JavaScript
// Author: John Smith (john.smith@acme.com)
// Version: 1.3.2
// Last Modified: 2023-11-10
// Dependencies: stripe@12.5.0, axios@1.5.0
```

## 3. Dependency Graph

```
[user.model.js] → [auth.controller.js] → [auth.routes.js]
[product.model.js] → [product.controller.js] → [product.routes.js]
[auth.controller.js] → [email.service.js]
[payment.service.js] → [product.controller.js]
[database.js] → [user.model.js, product.model.js]
```

## 4. Key Metrics
- Total Files: 12
- Direct Dependencies: 8
- Cyclic Dependencies: None
- Unused Imports: 0
```