AssistCliRunner class

The main command runner for the app

Inheritance

• Object
• CommandRunner<int>
• AssistCliRunner

Constructors

AssistCliRunner.new()

Properties

appDescription → String

no setter, inherited

argParser → ArgParser

The top-level argument parser.

no setter, inherited

commands → Map<String, Command<int>>

An unmodifiable view of all top-level commands defined for this runner.

no setter, inherited

completionInstallation → CompletionInstallation

The CompletionInstallation used to install completion files.

no setter, inherited

completionInstallationLogger → Logger

The Logger used to display messages during completion installation.

final, inherited

completionLogger → Logger

The Logger used to prompt the completion suggestions.

final, inherited

description → String

A short description of this executable.

final, inherited

enableAutoInstall → bool

Define whether the installation of the completion files should done automatically upon the first command run.

no setter, inherited

environmentOverride ↔ Map<String, String>?

Environment map which can be overridden for testing purposes.

getter/setter pair, inherited

errorAppDescription → String

no setter, inherited

executableName → String

The name of the executable being run.

no setter, override

getUsagePrefixLength → int

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

invocation → String

A single-line template for how to invoke this executable.

no setter, inherited

isDevMode → bool

no setter

logger → Logger

Getter for the logger instance used in the application.

no setter, inherited

publicUsageWithoutDescription → String

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

suggestionDistanceLimit → int

The maximum edit distance allowed when suggesting possible intended commands.

final, inherited

systemShell → SystemShell?

The SystemShell used to determine the current shell.

no setter, inherited

theme → Theme

no setter, inherited

topLevelOptions ↔ Map<String, Option>?

getter/setter pair, inherited

usage → String

Generates a string displaying usage information for the executable.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, override

version → String?

final, inherited

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