https://github.com/hibariya/pepin

Interactive filtering tool for CLI written in Ruby.
https://github.com/hibariya/pepin

Last synced: 13 days ago
JSON representation

Interactive filtering tool for CLI written in Ruby.

• Host: GitHub
• URL: https://github.com/hibariya/pepin
• Owner: hibariya
• License: mit
• Created: 2015-10-01T16:37:07.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-13T11:20:33.000Z (about 9 years ago)
• Last Synced: 2024-10-04T15:58:11.505Z (about 1 month ago)
• Language: Ruby
• Size: 174 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Pepin

[![Build Status](https://travis-ci.org/hibariya/pepin.svg?branch=master)](https://travis-ci.org/hibariya/pepin)

Pepin is a Percol and Peco like, interactive filtering tool for CLI written in Ruby.

`Pepin.search` Launches interactive window for filtering, and returns the filtered item.

![pepin example](https://cloud.githubusercontent.com/assets/43346/10299529/15627a4e-6c26-11e5-8e8e-fc74ea32371a.png)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'pepin'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install pepin

## Usage

The most simple example is below.

```ruby

#!/usr/bin/env ruby

require 'pepin'

list = %w(Alpha Bravo Charlie Delta Echo)

item = Pepin.search(list) # Launches interactive window and returns selected item

puts %(You selected "#{item}" from #{list.inspect}.)

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hibariya/pepin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).