class Squarectl::CLI

Overview

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:

Included Modules

Defined in:

squarectl/cli.cr
squarectl/cli/completion.cr
squarectl/cli/compose.cr
squarectl/cli/configs.cr
squarectl/cli/info.cr
squarectl/cli/kube.cr
squarectl/cli/secrets.cr
squarectl/cli/swarm.cr

Constant Summary

HELP = {"description" => ""}

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:

Class Method Summary

Instance Method Summary

Instance methods inherited from class Admiral::Command

rescue_unknown_cmd(&) rescue_unknown_cmd

Class Method Detail

def self.description #

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:


[View source]
def self.run(*args, **params) #

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:


[View source]

Instance Method Detail

def __rescue_from___Admiral__Error(e) #

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:


def arguments #

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:


[View source]
def flags #

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:


[View source]
def help #

def run #
Description copied from class Admiral::Command

The run command.


[View source]
def sub(command, *args, **params) #

Root of the Admiral command tree and the program entry point.

Each top-level subcommand (defined under cli/) registers its own leaf commands. Every leaf follows the same shape: load the config, resolve the environment for its target, build a Task, and hand off to a Tasks::* class. rescue_unknown_cmd (see admiral_patch.cr) prints help instead of crashing on an unknown subcommand.

:nodoc:


[View source]
def version #

[View source]