Type Alias getHelp

getHelp: (context: GetHelpOptions) => Promise<Help>

Generates the help information for a given command based on the provided tokens.

This function constructs a dynamic usage string based on the resolved commands and their parameters, then formats this information along with the description, available options, and subcommands. The output is structured using cliui for better formatting in the terminal.

Type declaration

- (context: GetHelpOptions): Promise<Help>
- Parameters
  - context: GetHelpOptions
    The context object for the command.
  Returns Promise<Help>

Type Alias getHelp

Type declaration

Parameters

Returns Promise<Help>

Settings