dyoung522 / devtools-base

Base class for various CLI utilities

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Code Climate Test Coverage

DevTools (Base)

DevTools is a compilation of utilities created to make the development process easier.

Installation

The base class is intended to be required in other tools via

require "devtools-base"

Usage

Once installed, this gem provides a base for several, mostly independent, utilities.

It gives you command line support, which includes the following options:

  • --help | -h : Command line help
  • --config | -c <FILE> : Include tools-specific options from config FILE
  • --version | -v : Print version information and exit

Additionally, the base will look for and load (if found) tool specific configuration items from one of the following files:

  • ~/.toolname
  • ./.toolname
  • ./toolname.rc
  • ./toolname.conf

Where toolname is the name of the executable using this base.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Contributing

Bug reports and pull requests are welcome on our GitHub page

License

The gem is available as open source under the terms of the MIT License.

About

Base class for various CLI utilities

License:MIT License


Languages

Language:Ruby 98.0%Language:Shell 2.0%