Returns the aliases of the command.

Allows to configure aliases for the command.

Allows to set the name of the command.

The value set using this method will be used by users when they invoke the command through the use of the manage CLI.

Returns the name of the considered command.

Allows to set the help description of the command.

Returns the help description of the command.

Setups the command and runs it.

This method will call the #setup method, configure the arguments / options parser and then execute the command through the use of the #run method. If the execution of the command produces an Errors::Exit exception (because the exit_raises option was set to true at initialization time), then the exception will be caught and the method will return the exit code.

Setups the command and runs it.

This method will call the #setup method, configure the arguments / options parser and then execute the command through the use of the #run method. Note this method won't silence Errors::Exit exceptions if the exit_raises option was set to true at initialization time.

Allows to configure a specific command argument.

This method will configure a command argument. It expects a name, a description, and it yields a block to let the command properly assign the argument value to the command object:

class MyCommand < Marten::CLI::Command
  def setup
    on_argument(:arg, "The name of the argument") do |value|
      @arg_var = value
    end
  end
end

Allows to configure a proc to call when invalid options are encountered.

This method will confiugure a proc to call when invalid options are encountered. The proc will be called for each invalid option, and it will receive the option flag as the first argument.

Allows to configure a specific command option.

This method will configure a command option (eg. --option). It expects a flag name, a short flag name, a description, and it yields a block to let the command properly assign the option value to the command object:

class MyCommand < Marten::CLI::Command
  def setup
    on_option("o", "option", "The name of the option") do
      @option_var = true
    end
  end
end

Note that the -- must not be included in the option name.

Allows to configure a specific command option.

This method will configure a command option (eg. --option). It expects a flag name, a description, and it yields a block to let the command properly assign the option value to the command object:

class MyCommand < Marten::CLI::Command
  def setup
    on_option(:option, "The name of the option") do
      @option_var = true
    end
  end
end

Note that the -- must not be included in the option name.

Allows to configure a specific command option with an associated argument.

This method will configure a command option (eg. --option) and an associated argument. It expects a flag name, a short flag name, an argument name, a description, and it yields a block to let the command properly assign the option value to the command object:

class MyCommand < Marten::CLI::Command
  def setup
    on_option_with_arg("o", "option", "arg", "The name of the option") do |arg|
      @arg = arg
    end
  end
end

Note that the -- must not be included in the option name.

Allows to configure a specific command option with an associated argument.

This method will configure a command option (eg. --option) and an associated argument. It expects a flag name, an argument name, a description, and it yields a block to let the command properly assign the option value to the command object:

class MyCommand < Marten::CLI::Command
  def setup
    on_option_with_arg(:option, :arg, "The name of the option") do |arg|
      @arg = arg
    end
  end
end

Note that the -- must not be included in the option name.

Allows to configure a proc to call when unknown arguments are encountered.

This method will configure a proc to call when unknown arguments are encountered. The proc will be called for each unknown argument, and it will receive the argument value as the first argument. Additionally, this method allows to specify the name of the unknown arguments (which will be used in the help message) and an optional description.

Allows to configure a proc to call when unknown arguments are encountered.

This method will configure a proc to call when unknown arguments are encountered. The proc will be called for each unknown argument, and it will receive the argument value as the first argument.

Allows to print a message to the output file descriptor.

This method will print a textual value to the output file descriptor, and it allows to optionally specify the ending character (which defaults to a newline):

print("This is a message")
print("This is a message without newline", ending = "")

Allows to print a message to the error file descriptor.

Allows to print a message to the error file descriptor and to exit the execution of the command.

The code used to exit the execution of the command can be specified using the exit_code argument (defaults to 1).

Runs the command.

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

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.

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.

Returns the IO object that should be used by the command as the main error file descriptor.

Returns the IO object that should be used by the command as the main input file descriptor.

Returns the IO object that should be used by the command as the main output file descriptor.

Allows to apply a style to a specific text value.

This method can be used to apply fore, back, and mode styles to a specific text values. This method is likely to be used in conjunction with the #print method when outputting messages:

print(style("This is a text", fore: :light_blue, back: :green, mode: :bold))