Quickstart

This page walks through the most common workflow: import a coverage file from your simulator, explore it interactively, then generate a shareable HTML report.

Step 1 — Import

Convert your simulator’s native coverage output to UCIS XML:

ucis convert --input-format vltcov coverage.dat -o coverage.xml

ucis convert --input-format cocotb-xml coverage.xml -o coverage_ucis.xml
# or for YAML output from cocotb-coverage:
ucis convert --input-format cocotb-yaml coverage.yml -o coverage_ucis.xml

ucis convert --input-format avl-json coverage.json -o coverage.xml

See Importing Coverage for more detail on each source.

Step 2 — Explore Interactively

The interactive terminal UI lets you browse coverage without generating a report file:

ucis view coverage.xml

Inside the TUI:

  • Press 1 for a Dashboard overview

  • Press 3 to see uncovered items (Gaps)

  • Press 4 for prioritized recommendations (Hotspots)

  • Press q to quit

See Exploring Coverage with TUI for the full TUI guide.

Step 3 — Generate a Shareable Report

ucis report coverage.xml -of html -o report.html

Open report.html in any browser — it is a single self-contained file that can be emailed, archived, or hosted on a web server without any extra dependencies.

Step 4 — Merge Multiple Runs (optional)

If you have coverage from several test runs, merge them before reporting:

ucis merge -o merged.xml test1.xml test2.xml test3.xml
ucis report merged.xml -of html -o merged_report.html

Next Steps