CliRunner class

Represents a cli runner responsible for running a command based on raw cli call data.

Inheritance

Constructors

argParser → ArgParser: The top-level argument parser.
no setterinherited
commands → Map<String, Command<void>>: An unmodifiable view of all top-level commands defined for this runner.
no setterinherited
description → String: A short description of this executable.
finalinherited
executableName → String: The name of the executable being run.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
invocation → String: Represents the invocation string message.
no setteroverride
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
suggestionDistanceLimit → int: The maximum edit distance allowed when suggesting possible intended commands.
finalinherited
usage → String: Generates a string displaying usage information for the executable.
no setterinherited
usageFooter → String?: An optional footer for usage.
no setterinherited

addCommand(Command<void> command) → void: Adds Command as a top-level command to this runner.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
parse(Iterable<String> args) → ArgResults: Parses args and returns the result, converting an ArgParserException to a UsageException.
inherited
printUsage() → void: Prints the usage information for this runner.
inherited
run(Iterable<String> args) → Future<void>: Main entry point for running a command.
override
runCommand(ArgResults topLevelResults) → Future<void>: Runs the command specified by topLevelResults.
inherited
toString() → String: A string representation of this object.
inherited
usageException(String message) → Never: Throws a UsageException with message.
inherited