module Mixlib::CLI::ClassMethods

Public Instance Methods

banner(bstring = nil) click to toggle source

Change the banner. Defaults to:

Usage: #{0} (options)

Parameters

bstring<String>

The string to set the banner to

Returns

@banner<String>

The current banner

option(name, args) click to toggle source

Add a command line option.

Parameters

name<Symbol>

The name of the option to add

args<Hash>

A hash of arguments for the option, specifying how it should be parsed.

Returns

true

Always returns true.

# File lib/mixlib/cli.rb, line 98
def option(name, args)
  @options ||= {}
  raise(ArgumentError, "Option name must be a symbol") unless name.kind_of?(Symbol)
  @options[name.to_sym] = args
end
options() click to toggle source

Get the hash of current options.

Returns

@options<Hash>

The current options hash.

# File lib/mixlib/cli.rb, line 108
def options
  @options ||= {}
  @options
end
options=(val) click to toggle source

Set the current options hash

Parameters

val<Hash>

The hash to set the options to

Returns

@options<Hash>

The current options hash.

# File lib/mixlib/cli.rb, line 120
def options=(val)
  raise(ArgumentError, "Options must recieve a hash") unless val.kind_of?(Hash)
  @options = val
end
use_separate_default_options(true_or_false) click to toggle source

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 83
def use_separate_default_options(true_or_false)
  @separate_default_options = true_or_false
end
use_separate_defaults?() click to toggle source
# File lib/mixlib/cli.rb, line 87
def use_separate_defaults?
  @separate_default_options ||= false
end