@gud/cli
    Preparing search index...

    Interface HelpRows

    The rows that make up the help information for a command. In order of appearance, the rows are:

    • description
    • usage
    • optionsTitle
    • options
    • subcommandsTitle
    • subcommands
    interface HelpRows {
        description?: Column;
        options?: [Column, Column][];
        optionsTitle?: Column;
        subcommands?: [Column, Column][];
        subcommandsTitle?: Column;
        usage: Column;
    }
    Index

    Properties

    description? options? optionsTitle? subcommands? subcommandsTitle? usage

    Properties

    description?: Column

    The command module's description.

    options?: [Column, Column][]

    A 2 column list of the available options and their descriptions.

    optionsTitle?: Column

    The title for the options section.

    subcommands?: [Column, Column][]

    A 2 column list of the available subcommands and their descriptions.

    subcommandsTitle?: Column

    The title for the subcommands section.

    usage: Column

    A dynamic usage string based on the resolved commands and their parameters.

    Settings

    Member Visibility

    On This Page

    Properties