CloudAdminCommand class

The admin command is used internally for Serverpod Cloud administration.

It is not intended to be used by end users and is hidden from the help command.

Inheritance

Constructors

CloudAdminCommand.new({required CommandLogger logger, bool hidden = true})

Properties

aliases → List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
The argument parser for this command.
no setterinherited
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
category → String
The command's category.
no setterinherited
description → String
A description of this command, included in usage.
final
envVariables → Map<String, String>
The environment variables used for configuration resolution.
finalinherited
globalConfiguration → GlobalConfiguration
Gets the current global configuration. Valid after the command runner has started running.
no setterinherited
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hidden → bool
Whether or not this command should be hidden from help listings.
final
invocation → String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
logger → CommandLogger
finalinherited
messageOutput → MessageOutput?
no setterinherited
name → String
The name of this command.
final
options → List<OptionDefinition>
The option definitions for this command.
finalinherited
parent → BetterCommand<dynamic, void>?
The command's parent command, if this is a subcommand.
no setterinherited
requireLogin → bool
Whether the command requires the user to be logged in. The default is true, subclasses can override to false.
finalinherited
runner → CloudCliCommandRunner
Gets the command runner CloudCliCommandRunner.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subcommands → Map<String, Command<void>>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases → List<String>
Alternate non-functional names for this command.
no setterinherited
summary → String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments → bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage → String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter → String?
An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command<void> command) → void
Adds Command as a subcommand of this.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
printUsage() → void
Prints the usage information for this command.
inherited
resolveConfiguration(ArgResults? argResults) → Configuration<OptionDefinition>
Resolves the configuration for this command.
inherited
run() → Future<void>
Runs this command. Subclasses should instead override runWithConfig.
inherited
runWithConfig(Configuration<OptionDefinition> commandConfig) → Future<void>
Runs this command with prepared configuration (options). Subclasses should override this method.
inherited
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

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