class Docr::Commands::Info

Defined in:

commands/info.cr

Instance Method Summary

Instance methods inherited from class Docr::Commands::Base

debug(data : _) : Nil debug, error(data : _) : Nil error, help_template : String help_template, info(data : _) : Nil info, on_error(ex : Exception) on_error, on_missing_arguments(args : Array(String)) on_missing_arguments, on_unknown_arguments(args : Array(String)) on_unknown_arguments, on_unknown_options(options : Array(String)) on_unknown_options, pre_run(arguments : Cling::Arguments, options : Cling::Options) : Nil pre_run

Constructor methods inherited from class Docr::Commands::Base

new new

Instance Method Detail

def pre_run(arguments : Cling::Arguments, options : Cling::Options) : Nil #
Description copied from class Cling::Command

A hook method to run once the command/subcommands, arguments and options have been parsed. This has access to the parsed arguments and options from the command line. This is useful if you want to implement checks for specific flags outside of the main #run method, such as -v/--version flags or -h/--help flags.


[View source]
def run(arguments : Cling::Arguments, options : Cling::Options) : Nil #
Description copied from class Cling::Command

The main point of execution for the command, where arguments and options can be accessed.


[View source]
def setup : Nil #
Description copied from class Cling::Command

An abstract method that should define information about the command such as the name, aliases, arguments, options, etc. The command name is required for all commands, all other values are optional including the help message.


[View source]