class Marten::CLI::Manage::Command::Gen

Defined in:

marten/cli/manage/command/gen.cr

Instance Method Summary

Instance methods inherited from class Marten::CLI::Manage::Command::Base

handle : Int32 handle, handle! : Nil handle!, on_argument(name : String | Symbol, description : String, &block : String -> ) on_argument, on_invalid_option(&block : String -> ) on_invalid_option, on_option(short_flag : String | Symbol, long_flag : String | Symbol, description : String, &block : String -> )
on_option(flag : String | Symbol, description : String, &block : String -> ) on_option, on_option_with_arg(short_flag : String | Symbol, long_flag : String | Symbol, arg : String | Symbol, description : String, &block : String -> )
on_option_with_arg(flag : String | Symbol, arg : String | Symbol, description : String, &block : String -> ) on_option_with_arg, on_unknown_argument(name : String | Symbol, description : String | Nil = nil, &block : String -> )
on_unknown_argument(&block : String -> ) on_unknown_argument, print(msg, ending = "\n") print, print_error(msg) print_error, print_error_and_exit(msg, exit_code = 1) print_error_and_exit, run run, setup setup, show_usage show_usage, stderr : IO stderr, stdin : IO stdin, stdout : IO stdout, style(msg, fore = nil, back = nil, mode = nil) style

Constructor methods inherited from class Marten::CLI::Manage::Command::Base

new(options : Array(String), stdin : IO = STDIN, stdout : IO = STDOUT, stderr : IO = STDERR, main_command_name : String = Marten::CLI::DEFAULT_COMMAND_NAME, exit_raises : Bool = false) new

Class methods inherited from class Marten::CLI::Manage::Command::Base

command_aliases
command_aliases(*aliases : String | Symbol) command_aliases, command_name(name : String | Symbol)
command_name command_name, help(help : String)
help help

Instance Method Detail

def run #
Description copied from class Marten::CLI::Manage::Command::Base

Runs the command.

This method should be overridden by subclasses in order to implement the execution logic of the considered command.


[View source]
def setup #
Description copied from class Marten::CLI::Manage::Command::Base

Setups the command.

This method should be overridden by subclasses in order to configure the command arguments and options through the use of the #on_argument and #on_option methods.


[View source]
def show_usage #
Description copied from class Marten::CLI::Manage::Command::Base

Shows the command usage.

This method is called when the help option is specified by the user. It will print the command usage to the output file descriptor by default.


[View source]