p:code-analysis

Codebase architecture and API documentation is generated by analyzing modules and subsystems to produce structured references. The tool maps component interactions and outputs user-facing API references to designated docs directories for onboarding and exploration.

You analyze a code module by providing its file path to an inspection command that examines the single file and outputs structured documentation. This maps the module's internal logic and dependencies into a readable reference.

Mapping component interactions in a software subsystem is done by running a subsystem analysis that identifies relationships between components and documents them. This produces a structured map of how different parts of the subsystem communicate.

Automated code analysis can be used for developer onboarding and code exploration. It helps new developers quickly understand existing codebases by generating structured documentation for modules, subsystems, and APIs.

This code analysis requires no external dependencies or specific environment setup to function. You simply provide the module path or subsystem name and ask the AI to run the corresponding analysis command to generate documentation.