search

as-cii / terminal-emojify

Outputs emoji aliases as raw characters.
MIT License
96 stars 5 forks source link

readme

Terminal Emojify

Outputs emoji aliases as raw characters.

Why?

Nowadays many projects use emojis as part of their contribution workflow. Commit messages are, therefore, full of these wonderful icons which, unfortunately, are not accessible in our terminal.

Terminal Emojify is here to change that.

Installation

$ gem install terminal-emojify

Example Usages

Beautiful git history

(straight from my .gitconfig :sunglasses:)

Edit your .gitconfig and define this alias:

[alias]
  hist = !git --no-pager log --color --pretty=format:'%C(yellow)%h%C(reset)%C(bold red)%d%C(reset) %s %C(black)— %an (%ad)%C(reset)' --relative-date | emojify | less --RAW-CONTROL-CHARS

Then run the command below on your repo:

$ git hist

Screenshot

If your terminal displays weird characters, please make sure you're running at least version 471 of less before reporting an issue. Thanks! :beers:

You can install the latest version of less via Homebrew:

`brew install less`

Psycho

(courtesy of http://emojisaurus.com/phrases/402-psycho)

$ echo ":hocho: :scream: :shower:" | emojify

Screenshot

Many others

What about you? Please, open an issue describing how you are using it and I will include it here :bow:.

Contributing

  1. Fork it ( https://github.com/as-cii/terminal-emojify/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request