mermaid

hugr.cli.mermaid(hugr_bytes: bytes, *, validate: bool = False, no_std: bool = False, extensions: list[str] | None = None) → str[source]

Generate mermaid diagrams from a HUGR package.

Parameters:

  • hugr_bytes – The HUGR package as bytes.

  • validate – Validate before rendering, includes extension inference (default: False).

  • no_std – Don’t use standard extensions when validating hugrs. Prelude is still used (default: False).

  • extensions – Paths to additional serialised extensions needed to load the HUGR.

Returns:

Mermaid diagram output as a string.