generate-project-profile

What problem does it solve?

It converts a codebase into a concise, evidence-anchored set of Markdown documents so AI agents and engineers can quickly understand project scope, data models, service capabilities, interfaces, events, and coding conventions without guessing or hallucinating.

Core Features & Use Cases

• Automated Project Indexing: Detects language, build config, modules, and service registration names to produce a compact project-profile.md index for fast context loading.
• Business Context Extraction: Generates business-context.md with data models, entity state machines, business capabilities, core workflows, transaction boundaries, and evidence sources for design and impact analysis.
• Code & Convention Snapshot: Produces coding-conventions.md summarizing naming, exception patterns, response wrappers, and business-related config for safe code generation and reviews.
• Use Case: Prepare AI agents for design review, code generation, or impact analysis by producing three targeted files (index, business context, coding conventions) that are optimized for vectorization and traceability.

Quick Start

Generate a project-profile, business-context, and coding-conventions for the current repository and save them under docs/.