Documentation
    Preparing search index...

    Type Alias CommandMetaData

    CommandMetaData: {
        help?: string | string[];
        commandName: string;
        description: string;
        namespace: string | null;
        aliases: string[];
        flags: Omit<Flag, "parse">[];
        args: Omit<Argument, "parse">[];
        options: CommandOptions;
    } & Record<string, any>

    Command metdata required to display command help.

    Type Declaration

    • Optionalhelp?: string | string[]

      Help text for the command

    • commandName: string

      The name of the command

    • description: string

      The command description to show on the help screen

    • namespace: string | null

      Command namespace. The namespace is extracted from the command name

    • aliases: string[]

      Command aliases. The same command can be run using these aliases as well.

    • flags: Omit<Flag, "parse">[]

      Flags accepted by the command

    • args: Omit<Argument, "parse">[]

      Args accepted by the command

    • options: CommandOptions

      Command configuration options

    Settings

    Member Visibility