unhappychoice/irasutoya-cli

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Irasutoya::Cli

[![Gem Version](https://badge.fury.io/rb/irasutoya-cli.svg)](https://badge.fury.io/rb/irasutoya-cli)
[![Code Climate](https://codeclimate.com/github/irasutoya-tools/irasutoya-cli/badges/gpa.svg)](https://codeclimate.com/github/irasutoya-tools/irasutoya-cli)
[![codecov](https://codecov.io/gh/irasutoya-tools/irasutoya-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/irasutoya-tools/irasutoya-cli)
[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/irasutoya-tools/irasutoya-cli.svg)](https://libraries.io/github/irasutoya-tools/irasutoya-cli)
![](http://ruby-gem-downloads-badge.herokuapp.com/irasutoya-cli?type=total)
![GitHub](https://img.shields.io/github/license/irasutoya-tools/irasutoya-cli.svg)

![](./images/example.png)

## Installation

```sh
$ gem install irasutoya-cli
```

To see preview of image, you need to use [iTerm2](https://iterm2.com/index.html) or terminals with [libsixel](https://github.com/saitoha/libsixel) installed.

## Usage

```sh
$ irasutoya
Commands:
  irasutoya help [COMMAND]  # Describe available commands or one specific command
  irasutoya random          # Gives you random irasutoya image
  irasutoya search {query}  # Gives you irasutoya 3 images by given query
```

## Contributing

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

## License

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

## Code of Conduct

Everyone interacting in the Irasutoya::Cli project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/unhappychoice/irasutoya-cli/blob/master/CODE_OF_CONDUCT.md).