skills.rest
B0yZ4kr14
B0yZ4kr14COMMUNITY
Explore all skills by this author →
WebsiteGitHub

speckit-repoindex-module

Generate a structured JSON index and human-readable profile from a module directory.

Updated Mar 16, 2026
Search Tags:#documentation generation#dependency mapping#repository analysis#codebase onboarding#module indexing#API inventory#data model extraction
One-click install
npx skills add https://github.com/B0yZ4kr14/OrthoPlus-Enterprise --skill speckit-repoindex-module
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: speckit-repoindex-module
Source: https://github.com/B0yZ4kr14/OrthoPlus-Enterprise/tree/main/.specify-backups/20260518-141826/_agents/skills/speckit-repoindex-module
Command: npx skills add https://github.com/B0yZ4kr14/OrthoPlus-Enterprise --skill speckit-repoindex-module

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It removes the manual effort of mapping a software module’s architecture by automatically producing a structured index and profile from the module source.

Core Features & Use Cases

  • Business-context extraction: identifies module purpose, scenarios, domain concepts, and business rules from the codebase and documentation.
  • Technical component analysis: inventories entry points, controllers/handlers, services, repositories/DAO, models/entities, configuration, and utilities.
  • Workflow + API + data modeling outputs: documents request flow, endpoint inventory, data entities/relationships, dependencies, and produces a structured JSON file index suitable for downstream automation.

Use case example: analyze a backend module to quickly understand its endpoints, database entities, and file responsibilities before refactoring or onboarding new developers.

Quick Start

Run the speckit-repoindex-module skill with the target module path as the argument and ask it to generate the module profile and file index for that module.

Frequently Asked Questions about speckit-repoindex-module

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

FAQPage Schema
How do I automatically generate a file index for a software module?▼

To generate a file index for a software module, you can analyze the module directory to extract business intent, technical components, and workflows, producing a structured JSON index and human-readable profile in one pass.

What is the best way to inventory API endpoints and data models during codebase onboarding?▼

Inventorying API endpoints and data models during codebase onboarding is done by extracting controllers, services, repositories, and entities from the module directory to map request flows and data relationships.

How does module structure analysis extract business context and domain concepts?▼

Module structure analysis extracts business context by evaluating source code and documentation to identify the module purpose, domain concepts, business rules, and technical components like entry points and utilities.

Can I map repository dependencies and workflows without manual code review?▼

Mapping repository dependencies and workflows without manual code review is possible by iteratively analyzing the module directory to document request flows, endpoint inventories, and data entities into a structured JSON output.

Does module indexing output a structured JSON format suitable for downstream automation?▼

Module indexing outputs a structured JSON file index alongside a human-readable profile, making the generated repository analysis suitable for downstream automation, refactoring, and developer onboarding scenarios.

When do I need to generate a module profile and grouped file index for a repository?▼

You need to generate a module profile and grouped file index when preparing for software maintenance or onboarding, allowing you to quickly understand file responsibilities, database entities, and endpoint inventories before refactoring.

Related Skills

Explore More Software Engineering Skills→
arrowInkneeeeearrowInkneeeee
1

spec-component-extractor

Extract component knowledge from Git repositories and generate 10-chapter Component Manuals.

Community
Advanced
metratonmetraton
3

memory-search

Search and retrieve episodic memory entries from Gaia's Memory v2 index.

Community
Intermediate
cryborg1211cryborg1211

Explore Codebase

Map codebase modules, dependencies, and relationships into a knowledge graph.

Community
Intermediate
jfrometajfrometa

lint-and-validate

Run lint, type checks, and security audits on Node.js and Python projects.

Community
Advanced