A command line interface command.

Implements
  • CLIResultHandler
Implemented by

Constructors

CLICommand()

Properties

defaultColorSymbol → String

read-only
description → String

read-only
detailedDescription → String

read-only
helpMeItsScary → bool

read-only
name → String

read-only
options → ArgParser

Options for this command.

read / write
outputSink → StringSink

read / write
showColors → bool

read-only
showStacktrace → bool

read-only
toolVersion → Version

read-only
usage → String

read-only
values → ArgResults

@override, read / write
hashCode → int

The hash code for this object.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

cleanup() → Future

Cleans up any resources used during this command.

colorSymbol(CLIColor color) → String

determineToolVersion() → Future

displayError(String errorMessage, { bool showUsage: false, CLIColor color: CLIColor.boldRed }) → void

displayInfo(String infoMessage, { CLIColor color: CLIColor.boldNone }) → void

displayProgress(String progressMessage, { CLIColor color: CLIColor.none }) → void

handle() → Future<int>

Handles the command input.

isExecutableInShellPath(String name) → bool

preProcess() → void

printHelp({String parentCommandName }) → void

process(ArgResults results, { List<String> parentCommandNames }) → Future<int>

Invoked on this instance when this command is executed from the command line.

registerCommand(CLICommand cmd) → void

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() → String

Returns a string representation of this object.

inherited