Create a new instance of Slop::Commands and optionally build Slop instances via a block. Any configuration options used in this method will be the default configuration options sent to each Slop object created.

config - An optional configuration Hash. block - Optional block used to define commands.

Examples:

  commands = Slop::Commands.new do
    on :new do
      on '-o', '--outdir=', 'The output directory'
      on '-v', '--verbose', 'Enable verbose mode'
    end

    on :generate do
      on '--assets', 'Generate assets', :default => true
    end

    global do
      on '-D', '--debug', 'Enable debug mode', :default => false
    end
  end

  commands[:new].class #=> Slop
  commands.parse

Fetch the instance of Slop tied to a command.

key - The String or Symbol key used to locate this command.

Returns the Slop instance if this key is found, nil otherwise.

Optionally set the banner for this command help output.

banner - The String text to set the banner.

Returns the String banner if one is set.

Add a Slop instance used when no other commands exist.

config - A Hash of configuration options to pass to Slop. block - An optional block used to pass options to Slop.

Returns the newly created Slop instance mapped to default.

Enumerable interface.

Alias for #[]

Add a global Slop instance.

config - A Hash of configuration options to pass to Slop. block - An optional block used to pass options to Slop.

Returns the newly created Slop instance mapped to global.

Alias for to_s

Returns the inspection String.

Add a Slop instance for a specific command.

command - A String or Symbol key used to identify this command. config - A Hash of configuration options to pass to Slop. block - An optional block used to pass options to Slop.

Returns the newly created Slop instance mapped to command.

Parse a list of items.

items - The Array of items to parse.

Returns the original Array of items.

Parse a list of items, removing any options or option arguments found.

items - The Array of items to parse.

Returns the original Array of items with options removed.

Check for a command presence.

Examples:

  cmds.parse %w( foo )
  cmds.present?(:foo) #=> true
  cmds.present?(:bar) #=> false

Returns true if the given key is present in the parsed arguments.

Returns a nested Hash with Slop options and values. See Slop#to_hash.

Returns the help String.