abstract class Crimson::Commands::Base
- Crimson::Commands::Base
- Cling::Command
- Reference
- Object
Direct Known Subclasses
- Crimson::App
- Crimson::Commands::Alias
- Crimson::Commands::Default
- Crimson::Commands::Env
- Crimson::Commands::Help
- Crimson::Commands::Import
- Crimson::Commands::Install
- Crimson::Commands::List
- Crimson::Commands::Remove
- Crimson::Commands::Setup
- Crimson::Commands::Switch
- Crimson::Commands::Test
- Crimson::Commands::Version
Defined in:
commands/base.crConstructors
Instance Method Summary
- #fatal(data : _) : NoReturn
-
#help_template : String
Returns the help template for this command.
-
#on_error(ex : Exception) : Nil
A hook method for when the command raises an exception during execution.
-
#on_invalid_option(message : String)
A hook method for when the command receives an invalid option, for example, a value given to an option that takes no arguments.
-
#on_missing_arguments(args : Array(String))
A hook method for when the command receives missing arguments during execution.
-
#on_unknown_arguments(args : Array(String))
A hook method for when the command receives unknown arguments during execution.
-
#on_unknown_options(options : Array(String))
A hook method for when the command receives unknown options during execution.
-
#pre_run(arguments : Cling::Arguments, options : Cling::Options) : Nil
A hook method to run once the command/subcommands, arguments and options have been parsed.
Constructor Detail
Instance Method Detail
Returns the help template for this command. By default, one is generated interally unless this method is overridden.
A hook method for when the command raises an exception during execution. By default, this raises the exception.
A hook method for when the command receives an invalid option, for example, a value given to
an option that takes no arguments. By default, this raises a CommandError.
A hook method for when the command receives missing arguments during execution. By default,
this raises a CommandError.
A hook method for when the command receives unknown arguments during execution. By default,
this raises a CommandError.
A hook method for when the command receives unknown options during execution. By default,
this raises an CommandError.
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.