Returns the commands for this Thor class and all subclasses.

Returns

Hash

An ordered hash with commands names as keys and Thor::Command objects as values.

If you want to use defaults that don’t match the type of an option, either specify ‘check_default_type: false` or call `allow_incompatible_default_type!`

Adds an argument to the class and creates an attr_accessor for it.

Arguments are different from options in several aspects. The first one is how they are parsed from the command line, arguments are retrieved from position:

thorcommandNAME

Instead of:

thorcommand--name=NAME

Besides, arguments are used inside your code as an accessor (self.argument), while options are all kept in a hash (self.options).

Finally, arguments cannot have type :default or :boolean but can be optional (supplying :optional => :true or :required => false), although you cannot have a required argument after a non-required argument. If you try it, an error is raised.

Parameters

name<Symbol>

The name of the argument.

options<Hash>

Described below.

Options

:desc - Description for the argument. :required - If the argument is required or not. :optional - If the argument is optional or not. :type - The type of the argument, can be :string, :hash, :array, :numeric. :default - Default value for this argument. It cannot be required and have default values. :banner - String to show on usage notes.

Errors

ArgumentError

Raised if you supply a required argument after a non required one.

Returns this class arguments, looking up in the ancestors chain.

Returns

Array

:nodoc:

:nodoc:

:nodoc:

:nodoc:

If you want to raise an error when the default value of an option does not match the type call check_default_type! This will be the default; for compatibility a deprecation warning is issued if necessary.

:nodoc:

If you want to raise an error for unknown options, call check_unknown_options! This is disabled by default to allow dynamic invocations.

:nodoc:

Adds and declares option group for required at least one of options in the block and arguments. You can declare options as the outside of the block.

Examples

class_at_least_onedoclass_option:oneclass_option:twoend

Or

class_option:oneclass_option:twoclass_at_least_one:one,:two

If you do not give “–one” and “–two” AtLeastOneRequiredArgumentError will be raised.

You can use class_at_least_one and class_exclusive at the same time.

class_exclusivedoclass_at_least_onedoclass_option:oneclass_option:twoendend

Then it is required either only one of “–one” or “–two”.

Returns this class at least one of required options array set, looking up in the ancestors chain.

Returns

Array[Array]

Adds and declares option group for exclusive options in the block and arguments. You can declare options as the outside of the block.

Parameters

Array

Examples

class_exclusivedoclass_option:oneclass_option:twoend

Or

class_option:oneclass_option:twoclass_exclusive:one,:two

If you give “–one” and “–two” at the same time ExclusiveArgumentsError will be raised.

Returns this class exclusive options array set, looking up in the ancestors chain.

Returns

Array[Array]

Adds an option to the set of class options

Parameters

name<Symbol>

The name of the argument.

options<Hash>

Described below.

Options

:desc

– Description for the argument.

:required

– If the argument is required or not.

:default

– Default value for this argument.

:group

– The group for this options. Use by class options to output options in different levels.

:aliases

– Aliases for this option.Note: Thor follows a convention of one-dash-one-letter options. Thus aliases like “-something” wouldn’t be parsed; use either “--something” or “-s” instead.

:type

– The type of the argument, can be :string, :hash, :array, :numeric or :boolean.

:banner

– String to show on usage notes.

:hide

– If you want to hide this option from the help.

Adds a bunch of options to the set of class options.

class_options:foo=>false,:bar=>:required,:baz=>:string

If you prefer more detailed declaration, check class_option.

Parameters

Hash[Symbol => Object]

Returns the commands for this Thor class.

Returns

Hash

An ordered hash with commands names as keys and Thor::Command objects as values.

If true, option set will not suspend the execution of the command when a required option is not provided.

A flag that makes the process exit with status 1 if any error happens.

Defines the group. This is used when thor list is invoked so you can specify that only commands from a pre-defined group will be shown. Defaults to standard.

Parameters

name<String|Symbol>

:nodoc:

:nodoc:

Sets the namespace for the Thor or Thor::Group class. By default the namespace is retrieved from the class name. If your Thor class is named Scripts::MyScript, the help method, for example, will be called as:

thor scripts:my_script -h

If you change the namespace:

namespace:my_scripts

You change how your commands are invoked:

thormy_scripts-h

Finally, if you change your namespace to default:

namespace:default

Your commands can be invoked with a shortcut. Instead of:

thor:my_command

All methods defined inside the given block are not added as commands.

So you can do:

classMyScript<Thorno_commandsdodefthis_is_not_a_commandendendend

You can also add the method and remove it from the command list:

classMyScript<Thordefthis_is_not_a_commandendremove_command:this_is_not_a_commandend

Allows to use private methods from parent in child classes as commands.

Parameters

names<Array>:: Method names to be used as commands

Examples

public_command:foopublic_command:foo,:bar,:baz

Removes a previous defined argument. If :undefine is given, undefine accessors as well.

Parameters

names<Array>

Arguments to be removed

Examples

remove_argument:fooremove_argument:foo,:bar,:baz,:undefine=>true

Removes a previous defined class option.

Parameters

names<Array>

Class options to be removed

Examples

remove_class_option:fooremove_class_option:foo,:bar,:baz

Removes a given command from this Thor class. This is usually done if you are inheriting from another class and don’t want it to be available anymore.

By default it only remove the mapping to the command. But you can supply :undefine => true to undefine the method from the class as well.

Parameters

name<Symbol|String>

The name of the command to be removed

options<Hash>

You can give :undefine => true if you want commands the method to be undefined from the class as well.

Parses the command and options from the given args, instantiate the class and invoke the command. This method is used when the arguments must be parsed from an array. If you are inside Ruby and want to use a Thor class, you can simply initialize it:

script=MyScript.new(args,options,config)script.invoke(:command,first_arg,second_arg,third_arg)

If true, option parsing is suspended as soon as an unknown option or a regular argument is encountered. All remaining arguments are passed to the command as regular arguments.

:nodoc:

If you want only strict string args (useful when cascading thor classes), call strict_args_position! This is disabled by default to allow dynamic invocations.

:nodoc: