module Mixlib::CLI::ClassMethods - mixlib-cli-1.7.0 Documentation

Source

# File lib/mixlib/cli.rb, line 133
def banner(bstring = nil)
  if bstring
    @banner = bstring
  else
    @banner ||= "Usage: #{$0} (options)"
    @banner
  end
end

Change the banner. Defaults to:

Usage: #{0} (options)

bstring<String>: The string to set the banner to

@banner<String>: The current banner

option (name, args)

Source

# 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

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.

options ()

Source

# File lib/mixlib/cli.rb, line 108
def options
  @options ||= {}
  @options
end

Get the hash of current options.

Returns

@options<Hash>: The current options hash.

options= (val)

Source

# 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

Set the current options hash

Parameters

val<Hash>: The hash to set the options to

Returns

@options<Hash>: The current options hash.

use_separate_default_options (true_or_false)

Source

# File lib/mixlib/cli.rb, line 83
def use_separate_default_options(true_or_false)
  @separate_default_options = true_or_false
end

When this setting is set to true, default values supplied to the mixlib-cli DSL will be stored in a separate Hash

use_separate_defaults? ()

Source

# File lib/mixlib/cli.rb, line 87
def use_separate_defaults?
  @separate_default_options ||= false
end