https://github.com/connoratherton/minimist

A tiny ruby ARGV parser.
https://github.com/connoratherton/minimist

Last synced: about 1 month ago
JSON representation

A tiny ruby ARGV parser.

• Host: GitHub
• URL: https://github.com/connoratherton/minimist
• Owner: ConnorAtherton
• License: mit
• Created: 2015-04-16T03:58:58.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T23:20:46.000Z (almost 2 years ago)
• Last Synced: 2024-04-29T07:42:33.562Z (7 months ago)
• Language: Ruby
• Homepage:
• Size: 176 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Minimist ![Build Status](https://api.travis-ci.org/ConnorAtherton/minimist.svg)

A tiny ruby ARGV parser.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'minimist'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install minimist

## Usage

This isn't designed to be as fully featured as things like OptionParser and Trollop.

I just wanted to get at cli arguments without having to use a fully-featured DSL to specify

exactly what I needed.

It accepts a string array and returns a hash containing commands and options.

```ruby

Minimist.parse("parse this --with=2 -asbd -n4 --no-changes --send two".split(" "))

=> {

  :commands=>["parse", "this"],

  :options=> {

    :with=>"2",

    :a=>true,

    :s=>true,

    :b=>true,

    :d=>true,

    :n=>"4",

    :changes=>false,

    :send=>"two"

  }

}

```

## Contributing

Create a pr discussing your change and make sure to add a test for your feature :)

1. Fork it ( https://github.com/[my-github-username]/minimist/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request