Skip to content
instance method

OptionParser#getopts

(*::String options) -> ::Hash[::String, untyped]
(::Array[::String] args, *::String options) -> ::Hash[::String, untyped]
getopts(*args, symbolize_names: false, **keywords)

Wrapper method for getopts.rb.

Example
params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option")
# params["a"] = true   # -a
# params["b"] = "1"    # -b1
# params["foo"] = "1"  # --foo
# params["bar"] = "x"  # --bar x
# params["zot"] = "z"  # --zot Z

Option symbolize_names (boolean) specifies whether returned Hash keys should be Symbols; defaults to false (use Strings).

Example
params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option", symbolize_names: true)
# params[:a] = true   # -a
# params[:b] = "1"    # -b1
# params[:foo] = "1"  # --foo
# params[:bar] = "x"  # --bar x
# params[:zot] = "z"  # --zot Z
See also .getopts #environment #help #def_tail_option also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0