https://github.com/ruby/optparse

OptionParser is a class for command-line option analysis.
https://github.com/ruby/optparse

hacktoberfest ruby

Last synced: 3 days ago
JSON representation

OptionParser is a class for command-line option analysis.

• Host: GitHub
• URL: https://github.com/ruby/optparse
• Owner: ruby
• License: other
• Created: 2020-05-22T11:10:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-13T23:12:04.000Z (14 days ago)
• Last Synced: 2025-01-15T08:08:04.901Z (13 days ago)
• Topics: hacktoberfest, ruby
• Language: Ruby
• Homepage:
• Size: 541 KB
• Stars: 54
• Watchers: 35
• Forks: 23
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# OptionParser

OptionParser is a class for command-line option analysis.  It is much more

advanced, yet also easier to use, than GetoptLong, and is a more Ruby-oriented

solution.

## Features

1. The argument specification and the code to handle it are written in the

   same place.

2. It can output an option summary; you don't need to maintain this string

   separately.

3. Optional and mandatory arguments are specified very gracefully.

4. Arguments can be automatically converted to a specified class.

5. Arguments can be restricted to a certain set.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'optparse'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install optparse

## Usage

```ruby

require 'optparse'

options = {}

OptionParser.new do |opts|

  opts.banner = "Usage: example.rb [options]"

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|

    options[:verbose] = v

  end

end.parse!

p options

p ARGV

```

## Development

After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/optparse.