/yacli

Primary LanguageRubyMIT LicenseMIT

Yacli

Gem Version Build Status

Coverage Status Codacy Badge

Description

Yacli a.k.a yet another CLI, is a simple gem allowing to build custom CLI wrappers. It uses Optimist as a CLI option manager as well as additional minimal helpers for logging and output handling.

Please note: Yacli, by design, is a system tool created to allow seamless file and url access, which should not receive application user input. It relies on open-uri, which combined with application user input would provide a command injection attack vector.

Prerequisites

You will need the following:

  • Ruby 2.5+
  • Bundler

Docker integration:

  • TBD

Installation

Add this line to your application's Gemfile:

gem 'yacli'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install yacli

Installation with Docker

TBD:

tbd

Usage

$ yacli help [COMMAND]                                          # Describe expanded available commands or one specific command

TODO

Wish-list of features TODO file for suggestions.

Contributing

  1. Fork it
  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 new Pull Request

License

Released under the MIT License. See the LICENSE file for further details.