Reference

Reports

Generate structured reports from the Software Graph — architecture, APIs, dependencies, frameworks, and workspace topology.

Available report types

The report command generates structured analysis from the graph. Each report type focuses on a specific dimension of the codebase.

TERMINAL

ontoly report summary            # full overview
ontoly report api                 # API endpoints and routes
ontoly report dependencies        # dependency analysis
ontoly report configuration       # configuration usage
ontoly report framework           # single framework deep-dive
ontoly report frameworks          # all detected frameworks
ontoly report controllers         # controller analysis
ontoly report routes              # route mapping
ontoly report modules             # module structure
ontoly report providers           # provider/DI analysis
ontoly report workspace           # monorepo workspace topology

Output formats

Reports support multiple output formats. Use markdown for documentation, JSON for automation, and mermaid for visual diagrams.

TERMINAL

ontoly report summary --format markdown
ontoly report summary --format json
ontoly architecture --format mermaid
ontoly architecture --format html
ontoly graph --format dot
ontoly graph --format graphml

Architecture report

The architecture command produces a high-level view of the codebase structure. Control the output size with node and edge limits.

TERMINAL

ontoly architecture --format mermaid
ontoly architecture --max-nodes 50 --max-edges 100
ontoly architecture --json

Coverage report

The coverage command analyzes how much of your codebase is represented in the graph and produces trust metrics.

TERMINAL

ontoly coverage . --format human
ontoly coverage . --format markdown
ontoly coverage . --format json