cli.rb

A command-line argument parser for Ruby.

Usage

require "cli"

cli =
  CLIRB.new do
    option :severity, "set severity", value: 4
    option :verbose, "enable verbose output"
    option :thing, "set thing", value: String
  end

cli.parse! ["--verbose", "some", "other", "args"]
cli.opts  #=> {:severity => 4, :verbose => true, :thing => nil}
cli.args  #=> ["some", "other", "args"]
cli.data  #=> ["some", "other", "args", {:severity => 4, :verbose => true, :thing => nil}]

Features

• no install - just paste in cli.rb (<60 loc) to your project and use it.
• no dependency to manage
• no validations or handling
• only parses the options and builds an argument list
• raises exceptions on errors - you do whatever handling you want

Notes

• You must define :value, if the option should accept an argument. Every option without :value is treated as a switch.
• To define long arguments with spaces and other special characters, define an option which takes a String as an argument. Everything between quotes will be parsed as the value for that argument.
• To define arguments which accept lists, define an option which takes an Array as an argument - the input will be split by comma. If the arguments contain spaces, wrap the whole thing in quotes.

Example

See the "example file" for details on usage and handling.

Installation

Paste the contents of the cli.rb file into your project under a namespace (anyway you see fit) and use it. Seriously, namespace your use of CLIRB so that you aren't referencing it from the global namespace (you'll help avoid conflicts with dependencies that also use cli.rb).

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am "Added some feature")
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request