CloudCliCommandRunner class

Represents the Serverpod Cloud CLI main command, its global options, and subcommands.

Inheritance
  • Object
  • CommandRunner<void>
  • CloudCliCommandRunner

Properties

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
envVariables → Map<String, String>
The environment variables used for configuration resolution.
finalinherited
executableName → String
The name of the executable being run.
finalinherited
globalConfiguration ↔ GlobalConfiguration
The curremt global configuration for the Serverpod Cloud CLI.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
invocation → String
A single-line template for how to invoke this executable.
no setterinherited
logger → CommandLogger
final
messageOutput → MessageOutput?
The MessageOutput for the command runner. It is also used for the commands unless they have their own.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceProvider → CloudCliServiceProvider
final
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 setteroverride
version → Version
final

Methods

addCommand(Command<void> command) → void
Adds Command as a top-level command to this runner.
inherited
addCommands(List<Command<void>> commands) → void
Adds a list of commands to the command runner.
inherited
analyticsEnabled() → bool
Checks if analytics is enabled.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parse(Iterable<String> args) → ArgResults
Parses the command line arguments and returns the result.
inherited
printUsage() → void
Prints the usage information for this runner.
inherited
resolveConfiguration(ArgResults? argResults) → Configuration<GlobalOption>
Resolves the global configuration for this command runner.
inherited
run(Iterable<String> args) → Future<void>
Parses args and invokes Command.run on the chosen command.
inherited
runCommand(ArgResults topLevelResults) → Future<void>
Runs the command specified by topLevelResults.
selectProjectDirectory() → String?
Selects a project directory that is either specified by the global configuration, or files found near the current directory. If no project directory is specified nor found then null is returned.
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited
verifiedProjectDirectory() → Directory
Selects and verifies the project directory that is either specified by the global configuration, or files found near the current directory.

Operators

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

Static Methods

create({required CommandLogger logger, Version? version, CloudCliServiceProvider? serviceProvider, bool? adminUserMode}) → CloudCliCommandRunner