CLI command

report

Generate a self-contained HTML report with metrics, filter verdicts, budget status, and optional trend analysis.

Command contract

Use report when the audience is broader than the terminal. The HTML output packages the current snapshot into a shareable artifact.

Best for

Stakeholder reviews, CI artifacts, and team discussions where a terminal transcript is the wrong format.

Writes files

Yes. Always writes ./simplicity-report/index.html relative to the current working directory.

Exit behavior

Returns 0 on success. Returns 1 if analysis or report generation fails.

Start with the exact command shape the CLI supports today.

Command

dotnet simplicity report path/to/YourSolution.sln

Generate a report after a local analysis pass and open it in a browser.

dotnet simplicity report samples/Sample.OverEngineered/Sample.OverEngineered.sln

Keep historical snapshots if you want the trend section to render a meaningful history line.

mkdir -p .simplicity-history
cp .simplicity-baseline.json .simplicity-history/2026-05-01.json
dotnet simplicity report YourSolution.sln

The command prints only the destination path, but the generated report includes the full narrative surface.

Executive summary and metric cards for the current snapshot.
Filter verdicts with summaries, violations, and next moves.
Complexity budget scorecard rendered from simplicity.json thresholds.
Trend analysis when .simplicity-history/ contains at least two readable snapshots.
A fully self-contained HTML file with inline styles and no external assets.

Sample output

Report generated to ./simplicity-report/index.html

These behaviors matter when you move from a local run to team automation.

The watch command ignores the simplicity-report directory so generating reports does not create watch loops.
Trend history is file-based today. You must save snapshot JSON files into .simplicity-history/ yourself; there is no dedicated snapshot archive command yet.
Because the output path is fixed, CI jobs usually upload the whole simplicity-report directory as an artifact.

Use the surrounding docs when you need setup, filter interpretation, or CI context.