https://github.com/watilde/emoji-cli

Emoji searcher
https://github.com/watilde/emoji-cli

emoji

Last synced: 17 days ago
JSON representation

Emoji searcher

• Host: GitHub
• URL: https://github.com/watilde/emoji-cli
• Owner: watilde
• License: mit
• Created: 2016-04-06T08:20:19.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-25T16:32:08.000Z (over 7 years ago)
• Last Synced: 2024-10-15T02:41:14.725Z (29 days ago)
• Topics: emoji
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/emoji-cli
• Size: 77.1 KB
• Stars: 81
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# emoji-cli [![Build Status](https://api.travis-ci.org/watilde/emoji-cli.svg)](https://travis-ci.org/watilde/emoji-cli)

Emoji searcher

## install

via npm

```

$ npm install -g emoji-cli

```

## usage

See `emoji -h`

```

Usage: emoji 

Options:

  -h, --help     output usage information

  -V, --version  output the version number

  -f, --fuzzy    use fuzzy search

  -r, --random   pick a emoji randomly and copy it to clipboard

```

## screenshots

One result

![emoji](./img/emoji.png)

Multiple results

![emojis](./img/emojis.png)

Pick a emoji randomly

![random emoji](./img/random_emoji.png)

Emoji not found

![emoji not found](./img/emoji_not_found.png)

## api

Basic usage. Checkout the `test/` folder for `require('emoji-cli')` examples.

```

var emoji = require('emoji-cli')

// callback ------------------------------------------+

// options ---------------------------+               |

// keywords -------+                  |               |

// method -+       |                  |               |

//         v       v                  v               v

    emoji.search(['face', 'smile'], {random: true}, function (err, emoji) {

      console.log(emoji)

    })

```

### emoji.search(keywords, options, callback)

+ `keywords` {Array} Arguments to `emoji` command

+ `options` {Object} Can be `random: true`, or `fuzzy: true`

+ `callback` {Function} To receive results

## License

MIT