Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bachya/cliutils

A library to alleviate common tasks and headaches in Ruby CLI apps
https://github.com/bachya/cliutils

Last synced: 11 days ago
JSON representation

A library to alleviate common tasks and headaches in Ruby CLI apps

Host: GitHub
URL: https://github.com/bachya/cliutils
Owner: bachya
License: mit
Created: 2014-03-29T19:11:27.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2021-12-02T21:02:02.000Z (almost 3 years ago)
Last Synced: 2024-10-04T16:16:25.472Z (about 1 month ago)
Language: Ruby
Size: 1.83 MB
Stars: 12
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.txt

Awesome Lists containing this project

README

CLIUtils
====
[![Build Status](https://travis-ci.org/bachya/cliutils.svg?branch=master)](https://travis-ci.org/bachya/cliutils)
[![Gem Version](https://badge.fury.io/rb/cliutils.svg)](http://badge.fury.io/rb/cliutils)
[![Coverage Status](http://img.shields.io/coveralls/bachya/cliutils/master.svg)](https://coveralls.io/r/bachya/cliutils?branch=master)

CLIUtils is a library of functionality designed to alleviate common tasks and
headaches when developing command-line (CLI) apps in Ruby.

# *Updating from 1.x.x to 2.0.0?*

The big difference is schema changes for Validators, Behaviors, and Pre-Post
Actions. Make sure you read the [wiki](https://github.com/bachya/cliutils/wiki "CLIUtils Wiki").

# Why?

It's fairly simple:

1. I love developing Ruby-based CLI apps.
2. I found myself copy/pasting common code from one to another.
3. I decided to do something about it.

# Libraries

CLIUtils offers:

* **PrettyIO:** some basic CLI sugar
* **Messaging:** a system to display nicely-formatted messages to one or more tagets
* **Configuration:** a app configuration manager
* **Prefs:** a preferences prompter and manager

...along with plenty of documentation:

* [Wiki](https://github.com/bachya/cliutils/wiki "CLIUtils Wiki")
* [YARD documentation](http://rubydoc.info/github/bachya/cliutils/master/frames "YARD Documentation")

# Compatibility

CLIUtils is certified against the following:

* Ruby 2.1.1
* Ruby 2.1.0
* Ruby 2.0.0
* Ruby 1.9.3

# Installation

Add this line to your application's Gemfile:

```bash
$ gem 'cliutils'
```

And then execute:

```bash
$ bundle
```

Or install it yourself:

```bash
$ gem install cliutils
```

# Usage

```Ruby
require 'cliutils'
```

If you want to mix in everything that CLIUtils has to offer:

```Ruby
include CLIUtils
```

# Can I use it with...?

I often get asked how nicely CLIUtils plays with other Ruby-based CLI
libraries (like Dave Copeland's excellent
[Methadone](https://github.com/davetron5000/methadone "Methadone") and
[GLI](https://github.com/davetron5000/gli "GLI")). Answer: they play very
nicely. I use CLIUtils in
[Sifttter Redux](https://github.com/bachya/Sifttter-Redux "Sifttter Redux")
(which is built on GLI) and
[ExpandSync](https://github.com/bachya/ExpandSync "ExpandSync") (which is built
on Methadone).

# Bugs and Feature Requests

To view my current roadmap and objectives, check out the
[Trello board](https://trello.com/b/qXs7Yeir/cliutils "CLIUtils on Trello").

To report bugs with or suggest features/changes for CLIUtils, please use
the [Issues Page](http://github.com/bachya/cliutils/issues).

# Contributing

Contributions are welcome and encouraged. To contribute:

1. Fork it (http://github.com/bachya/cliutils/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
* Make sure you add tests!
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

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.