https://github.com/ruby/getoptlong
The GetoptLong class allows you to parse command line options similarly to the GNU getopt_long() C library call.
https://github.com/ruby/getoptlong
ruby
Last synced: 6 months ago
JSON representation
The GetoptLong class allows you to parse command line options similarly to the GNU getopt_long() C library call.
- Host: GitHub
- URL: https://github.com/ruby/getoptlong
- Owner: ruby
- License: bsd-2-clause
- Created: 2019-08-06T03:52:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-08-18T07:26:52.000Z (9 months ago)
- Last Synced: 2025-10-09T12:14:11.536Z (7 months ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 60.5 KB
- Stars: 7
- Watchers: 33
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Getoptlong
The GetoptLong class allows you to parse command line options similarly to
the GNU getopt_long() C library call. Note, however, that GetoptLong is a
pure Ruby implementation.
GetoptLong allows for POSIX-style options like --file as well
as single letter options like -f
The empty option -- (two minus symbols) is used to end option
processing. This can be particularly important if options have optional
arguments.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'getoptlong'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install getoptlong
## Usage
```ruby
require 'getoptlong'
opts = GetoptLong.new(
[ '--help', '-h', GetoptLong::NO_ARGUMENT ],
[ '--repeat', '-n', GetoptLong::REQUIRED_ARGUMENT ],
[ '--name', GetoptLong::OPTIONAL_ARGUMENT ]
)
dir = nil
name = nil
repetitions = 1
opts.each do |opt, arg|
case opt
when '--help'
puts <<-EOF
hello [OPTION] ... DIR
-h, --help:
show help
--repeat x, -n x:
repeat x times
--name [name]:
greet user by name, if name not supplied default is John
DIR: The directory in which to issue the greeting.
EOF
when '--repeat'
repetitions = arg.to_i
when '--name'
if arg == ''
name = 'John'
else
name = arg
end
end
end
if ARGV.length != 1
puts "Missing dir argument (try --help)"
exit 0
end
dir = ARGV.shift
Dir.chdir(dir)
for i in (1..repetitions)
print "Hello"
if name
print ", #{name}"
end
puts
end
```
Example command line:
```
hello -n 6 --name -- /tmp
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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/getoptlong.