Creates a method of arg_name that returns the value passed in from the CLI. The CLI arg is specified by the --arg_name=VALUE flag.

• arg_name : String - The name of the argument
• description : String - The help text description for this option
• shorcut : String - An optional short flag (e.g. -a VALUE)
• optional : Bool - When false, raise exception if this arg is not passed
• format : Regex - The format you expect the args to match
• example : String - An example string that matches the given format

Sets a custom title for the task

By default the name is derived from the full module and class name. However if that name is not desired, a custom one can be set.

class Dev::Prime < LuckyTask::Task
  # Would be "dev.prime" by default, but we want to set it to "dev.setup":
  name "dev.setup"
  summary "Seed the development database with example data"

  # other methods, etc.
end

Creates a method of arg_name that returns the value passed in from the CLI. The CLI arg position is based on the order in which positional_arg is specified with the first call being position 0, and so on.

If your arg takes more than one value, you can set to_end to true to capture all args from this position to the end. This will make your arg_name method return Array(String).

• arg_name : String - The name of the argument
• description : String - The help text description for this option
• to_end : Bool - Capture all args from this position to the end.
• format : Regex - The format you expect the args to match
• example : String - An example string that matches the given format

Creates a method of arg_name where the return value is boolean. If the flag --arg_name is passed, the value is true.

• arg_name : String - The name of the argument
• description : String - The help text description for this option
• shorcut : String - An optional short flag (e.g. -a)