Skip to Content
ReportsHTML Report

HTML Report

The HTML report generates a standalone, self-contained HTML file with embedded CSS. It presents the same data as the CLI report in a clean, browser-readable format that can be shared, archived, or embedded in dashboards.

Generating an HTML Report

Use the --output html flag with the run command:

agenticassure run scenarios/ --adapter my_agent.MyAgent --output html

After the run completes, AgenticAssure writes the report and prints the filename:

HTML report written to report_a1b2c3d4-e5f6-7890-abcd-ef1234567890.html

File Naming

HTML reports are named using the pattern:

report_{run_id}.html

The run_id is a UUID generated for each run. This ensures that multiple runs produce distinct files and no results are accidentally overwritten. Files are written to the current working directory.

What the Report Contains

The HTML report is a single-page document with the following sections:

  • Title: “AgenticAssure Report”
  • Suite name, Run ID (first 8 characters), and timestamp in ISO 8601 format.

Summary Statistics

A row of four key metrics displayed prominently at the top:

StatDescription
Pass RatePercentage of scenarios that passed, displayed as a percentage (e.g., “75%“)
Avg ScoreThe aggregate average score across all scenarios, from 0.00 to 1.00
ScenariosTotal number of scenarios in the run
DurationTotal wall-clock duration for all scenarios in milliseconds

Results Table

A table with one row per scenario, containing the same columns as the CLI report:

ColumnDescription
ScenarioScenario name
StatusPASS, FAIL, or ERROR, displayed as a colored badge
ScoreAverage score across all scorers for the scenario
DurationExecution time in milliseconds
DetailsScorer explanations or error message

Rows are color-coded:

  • Passing scenarios have a light green background.
  • Failing scenarios have a light red background.

Status badges use distinct colors:

  • PASS: green badge with dark green text.
  • FAIL / ERROR: red badge with dark red text.

Styling

The report uses embedded CSS with no external dependencies. It uses the system font stack (-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif) for clean rendering across platforms. The layout is responsive with a maximum width of 1000px, centered on the page.

Opening the Report

The HTML file can be opened directly in any web browser:

# macOS open report_a1b2c3d4.html # Linux xdg-open report_a1b2c3d4.html # Windows start report_a1b2c3d4.html

Since all CSS is embedded inline, the file works offline and can be moved, emailed, or uploaded anywhere without losing formatting.

Sharing the Report

Because the report is a single self-contained file, sharing is straightforward:

  • Email: Attach the HTML file directly.
  • Slack / Teams: Upload as a file attachment.
  • Pull requests: Attach to a PR comment or upload as a build artifact.
  • CI artifacts: Upload the file as a build artifact in your CI system (see below).

Uploading as a CI Artifact

GitHub Actions:

- name: Run AgenticAssure tests run: agenticassure run scenarios/ --adapter my_agent.MyAgent --output html - name: Upload report uses: actions/upload-artifact@v4 with: name: agenticassure-report path: report_*.html

GitLab CI:

test: script: - agenticassure run scenarios/ --adapter my_agent.MyAgent --output html artifacts: paths: - report_*.html

Embedding in Dashboards

The HTML report can be embedded in internal dashboards or documentation portals using an <iframe>:

<iframe src="report_a1b2c3d4.html" width="100%" height="600" frameborder="0"></iframe>

For dashboards that require structured data rather than rendered HTML, consider using the JSON report instead.

Multi-Suite Runs

When running multiple suites, each suite generates its own HTML report file. You will see one output line per suite:

HTML report written to report_a1b2c3d4.html HTML report written to report_e5f67890.html

What’s Next

Last updated on