Skip to content

Export & script reports

From an open Interactive Report's window:

  • Export HTML / Export PDF / Export Text (multi-page reports also offer per-page versions) — the window's Save button only covers these three formats.
  • Copy API command to clipboard copies (and displays) the exact und report command that regenerates this report from the command line, with the current target and options already filled in.

CSV and PNG output aren't available from the report window — use und report or the Python API below for those. Batch Reports are already written to HTML/text when you generate them — see What is a report & how do I run one?.

Need Mermaid text instead?

None of these export paths emit Mermaid — use the Mermaid Graph interactive reports for a paste-ready text diagram.

Generate reports from the command line

und report produces both built-in and interactive reports headlessly.

# A named report to a directory (HTML by default)
und report "API Info" out_dir myProject.und

# Choose one or more formats
und report -format pdf,csv,png "Report Name" out_dir myProject.und

# Target a specific entity or architecture
und report -ent @lchimaera@kchimaera@f./egrep.c "API Info" out.pdf myProject.und
und report -arch "Directory Structure" "Report Name" out_dir myProject.und

# Regenerate the configured built-in Batch Reports (no report name)
und report myProject.und
  • -format accepts pdf, html, txt, csv, png (CSV emits tables only; PNG emits images only). With no -format, a .txt/.pdf output extension picks the format; otherwise the output must be a directory and HTML is used.
  • -codecheck <sarif> runs the report over a CodeCheck inspection (a second SARIF makes a diff report) — see Produce a compliance report.
  • -options "key=value;..." sets report-specific options.
  • With no report name, und report regenerates the built-in Batch Reports using the current report settings (und list -reports settings, changed via und settings).

Licensing & formats

und report requires the external-export capability of your license. PDF and PNG output require the graphics libraries included in the full install. See Run Understand from the command line.

Generate reports from the Python API

Call db.report(), ent.report(), or arch.report() to generate a report from a script — same required name and filename, and the same optional format (pdf, html, txt, csv, png; comma-separate more than one) as und report. See the Python API's report generation reference for the full signature.