abstract class MStrap::Step

Included Modules

Direct Known Subclasses

Defined in:



Class Method Summary

Instance Method Summary

Instance methods inherited from module MStrap::DSL::System

cmd(env : Hash | Nil, command : String, args : Array(String) | Nil, shell = true, input = Process::Redirect::Inherit, output = Process::Redirect::Inherit, error = Process::Redirect::Inherit, quiet = false, sudo = false) cmd

Instance methods inherited from module MStrap::DSL::Logging

log(msg) log, logc(msg) logc, logd(msg) logd, logn(msg) logn, logw(msg) logw, success(msg) success

Constructor Detail

def self.new(config : Configuration, cli_options : CLIOptions, args : Array(String) = [] of String) #

Initializes the step. Called by MStrap::Bootsrapper. Typically not called directly.

[View source]

Class Method Detail

def self.description #

Short description of the step. Leveraged by the CLI help system.

[View source]
def self.long_description #

[View source]
def self.requires_mstrap? #

Whether the step requires the mstrap environment to be loaded (env.sh)

[View source]
def self.requires_shell_restart? #

Whether the step requires the shell to be restarted after being run

[View source]
def self.setup_cmd!(cmd : Commander::Command) #

Hook that can be implemented to modify CLI command flags or subcommands.

[View source]

Instance Method Detail

def args : Array(String) #

Extra arguments passed to the step not processed by the main CLI

[View source]
abstract def bootstrap #

Executes the step

[View source]
def config : MStrap::Configuration #

Loaded configuration for mstrap

[View source]
def options : MStrap::CLIOptions #

Options passed from the CLI

[View source]
def profile : MStrap::Defs::ProfileDef #

Resolved profile for mstrap

[View source]
def user : MStrap::User #

User configured for mstrap

[View source]