Skip to content

Generate reports

🌐 HTML report

AST Metrics can generate HTML reports. The reports provide an overview of the codebase, including:

  • The number of files and directories
  • The number of lines of code
  • Maintainability, complexity, and risk scores

To generate a report, run the following command in your terminal:

ast-metrics --report-html=<report-directory> /path/to/your/project

Where <report-directory> is the directory where the report will be saved.

📄 Markdown report

AST Metrics can also generate Markdown reports. The reports provide an overview of the codebase, in markdown format.

To generate a report, run the following command in your terminal:

ast-metrics --report-markdown=<report-file.md> /path/to/your/project

Where <report-file.md> is the file where the report will be saved.

📄 JSON report

AST Metrics can also generate JSON reports. The reports provide an overview of the codebase, in JSON format.

To generate a report, run the following command in your terminal:

ast-metrics --report-json=<report-file.json> /path/to/your/project

Where <report-file.json> is the file where the report will be saved.

📄 OpenMetrics report (Gitlab CI)

OpenMetrics is a standard for metrics exposition. AST Metrics can generate OpenMetrics reports, which can be easily integrated into your CI/CD pipeline, like GitLab CI.