AssistCliRunner class - cli.runner library

Constructors

AssistCliRunner()

Properties

appDescription → String: no setterinherited
argParser → ArgParser: The top-level argument parser.
no setterinherited
commands → Map<String, Command<int>>: An unmodifiable view of all top-level commands defined for this runner.
no setterinherited
completionInstallation → CompletionInstallation: The CompletionInstallation used to install completion files.
no setterinherited
completionInstallationLogger → Logger: The Logger used to display messages during completion installation.
finalinherited
completionLogger → Logger: The Logger used to prompt the completion suggestions.
finalinherited
description → String: A short description of this executable.
finalinherited
enableAutoInstall → bool: Define whether the installation of the completion files should done automatically upon the first command run.
no setterinherited
environmentOverride ↔ Map<String, String>?: Environment map which can be overridden for testing purposes.
getter/setter pairinherited
errorAppDescription → String: no setterinherited
executableName → String: The name of the executable being run.
no setteroverride
getUsagePrefixLength → int: no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
invocation → String: A single-line template for how to invoke this executable.
no setterinherited
isDevMode → bool: no setter
logger → Logger: Getter for the logger instance used in the application.
no setterinherited
publicUsageWithoutDescription → String: no setterinherited
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
systemShell → SystemShell?: The SystemShell used to determine the current shell.
no setterinherited
theme → Theme: no setterinherited
topLevelOptions ↔ Map<String, Option>?: getter/setter pairinherited
usage → String: Generates a string displaying usage information for the executable.
no setterinherited
usageFooter → String?: An optional footer for usage.
no setteroverride
version → String?: finalinherited

Methods

addCommand(Command<int> 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
renderCompletionResult(CompletionResult completionResult) → void: Renders a CompletionResult into the current system shell.
inherited
run(Iterable<String> args) → Future<int>: Parses args and invokes Command.run on the chosen command.
inherited
runCommand(ArgResults topLevelResults) → Future<int?>: Runs the command specified by topLevelResults.
inherited
safeRun(List<String> args) → Future<void>: inherited
toString() → String: A string representation of this object.
inherited
usageException(String message) → Never: Throws a UsageException with message.

Operators

operator ==(Object other) → bool: The equality operator.
inherited