binaryninja.interaction.show_markdown_report

show_markdown_report(title, contents, plaintext='')[source]

show_markdown_report displays the markdown contents in UI applications and plaintext in command-line applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: binaryninja://?expr='_start' Where expr= specifies an expression parsable by the parse_expression API.

Note: This API function differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line
a simple text prompt is used.
Parameters:
  • contents (str) – markdown contents to display
  • plaintext (str) – Plain text version to display (used on the command-line)
Return type:

None

Example:
>>> show_markdown_report("title", "##Contents", "Plain text contents")
Plain text contents