CliCommand class abstract
A command line interface command.
- Inheritance
- Implementers
Constructors
Properties
-
aliases
→ List<
String> -
Alternate names for this command.
no setterinherited
- argParser → ArgParser
-
The argument parser for this command.
no setterinherited
- argResults → ArgResults
-
The parsed argument results for this command.
no setteroverride
- category → String
-
The command's category.
no setterinherited
-
defineList
→ List<
String> -
latefinal
- description → String
-
A description of this command, included in usage.
no setterinherited
- directory → Directory
-
latefinal
- directoryPath → String
-
latefinal
- globalResults → ArgResults?
-
The parsed global argument results.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
Whether or not this command should be hidden from help listings.
no setterinherited
- invocation → String
-
A single-line template for how to invoke this command (e.g.
"pub get
package"
).no setterinherited - name → String
-
The name of this command.
no setterinherited
- package → String
-
latefinal
-
parent
→ Command<
int> ? -
The command's parent command, if this is a subcommand.
no setterinherited
- pubspec → PubSpec
-
latefinal
- pubspecFile → File
-
latefinal
-
runner
→ CommandRunner<
int> ? -
The command runner for this command.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subcommands
→ Map<
String, Command< int> > -
An unmodifiable view of all sublevel commands of this command.
no setterinherited
-
suggestionAliases
→ List<
String> -
Alternate non-functional names for this command.
no setterinherited
- summary → String
-
A short description of this command, included in parent's
CommandRunner.usage
.no setterinherited - takesArguments → bool
-
Whether or not this command takes positional arguments in addition to
options.
no setterinherited
- target → String
-
latefinal
- targetFile → File
-
latefinal
- targetPath → String
-
latefinal
- usage → String
-
Generates a string displaying usage information for this command.
no setterinherited
-
An optional footer for usage.
no setterinherited
Methods
-
addSubcommand(
Command< int> command) → void -
Adds
Command
as a subcommand of this.inherited -
check(
) → Future< void> -
cleanup(
) → Future< void> -
handle(
) → Future< int> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
printUsage(
) → void -
Prints the usage information for this command.
inherited
-
renderTemplate(
String name, Map< String, String> data) → Future<String> -
run(
) → Future< int> -
Runs this command.
override
-
toString(
) → String -
A string representation of this object.
inherited
-
usageException(
String message) → Never -
Throws a
UsageException
withmessage
.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited