Skip to content
Not released yet: version 0.1 is being built. See what works today.

Help topics

A help topic is guidance that is not a command, such as how to build a report. It works as gh help <topic> does: mb help lists the topics, mb help <topic> prints one, and mb --help names them under the commands. --json gives {topic, title, body, links: [{label, url}]}. An unknown topic is refused with usage.unknown_help_topic and exit 2, and the suggestion lists the topics.

Each topic is a Markdown file in metrics_book/help_topics/, shipped with mb. A test fails when this table and that folder differ.

Topic Title
reports Building reports and Data Apps