HelpCommand<T> class Null safety

The built-in help command that's added to every CommandRunner.

This command displays help information for the various subcommands.

Inheritance

Constructors

HelpCommand()

Properties

aliases List<String>
Alternate names for this command. [...]
read-only, inherited
argParser ArgParser
The argument parser for this command. [...]
read-only, inherited
argResults ArgResults?
The parsed argument results for this command. [...]
read-only, inherited
description String
A description of this command, included in usage.
read-only, override
globalResults ArgResults?
The parsed global argument results. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
hidden bool
Whether or not this command should be hidden from help listings. [...]
read-only, override
invocation String
A single-line template for how to invoke this command (e.g. "pub getpackage").
read-only, override
name String
The name of this command.
final
parent Command<T>?
The command's parent command, if this is a subcommand. [...]
read-only, inherited
runner CommandRunner<T>?
The command runner for this command. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
subcommands Map<String, Command<T>>
An unmodifiable view of all sublevel commands of this command.
read-only, inherited
summary String
A short description of this command, included in parent's CommandRunner.usage. [...]
read-only, inherited
takesArguments bool
Whether or not this command takes positional arguments in addition to options. [...]
read-only, inherited
usage String
Generates a string displaying usage information for this command. [...]
read-only, inherited
usageFooter String?
An optional footer for usage. [...]
read-only, inherited

Methods

addSubcommand(Command<T> command) → void
Adds Command as a subcommand of this.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
printUsage() → void
Prints the usage information for this command. [...]
inherited
run() Null
Runs this command. [...]
override
toString() String
A string representation of this object. [...]
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited