Skip to content

Help Generator

Adam Wolfe edited this page Aug 1, 2024 · 1 revision

Overview

Imperative automatically generates and displays help content when requested:

  • Users can specify --help or -h on any command (Imperative auto-appends the --help option)
  • If a user issues a partial command (stopping at a group) Imperative will display the help to guide the user on what can be specified after the current group

Overriding the Help Generator

If you need to re-implement the help displays, you can supply a custom help generator class on the Imperative Config customHelpGenerator property. You must specify a path to a Node.js require()-able module that extends the AbstractHelpGenerator.