module Mixlib::CLI::ClassMethods

Public Instance Methods

banner(bstring=nil) click to toggle source

Change the banner. Defaults to:

Usage: #{0} (options)

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

@banner<String>: The current banner

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

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 31
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 41
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 53
def options=(val)
  raise(ArgumentError, "Options must recieve a hash") unless val.kind_of?(Hash)
  @options = val
end