Add a command line option.
name<Symbol> |
The name of the option to add |
args<Hash> |
A hash of arguments for the option, specifying how it should be parsed. |
true |
Always returns true. |
# File lib/mixlib/cli.rb, line 60 def option(name, args) @options ||= {} raise(ArgumentError, "Option name must be a symbol") unless name.kind_of?(Symbol) @options[name.to_sym] = args end
Get the hash of current options.
@options<Hash> |
The current options hash. |
# File lib/mixlib/cli.rb, line 70 def options @options ||= {} @options end
Set the current options hash
val<Hash> |
The hash to set the options to |
@options<Hash> |
The current options hash. |
# File lib/mixlib/cli.rb, line 82 def options=(val) raise(ArgumentError, "Options must recieve a hash") unless val.kind_of?(Hash) @options = val end
When this setting is set to true, default values supplied to the mixlib-cli DSL will be stored in a separate Hash
# File lib/mixlib/cli.rb, line 45 def use_separate_default_options(true_or_false) @separate_default_options = true_or_false end
Generated with the Darkfish Rdoc Generator 2.