Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrowa44/emojify
Emoji on the command line :scream:
https://github.com/mrowa44/emojify
Last synced: 6 days ago
JSON representation
Emoji on the command line :scream:
- Host: GitHub
- URL: https://github.com/mrowa44/emojify
- Owner: mrowa44
- License: mit
- Created: 2015-07-24T00:58:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-08T15:26:52.000Z (11 months ago)
- Last Synced: 2024-11-29T11:07:14.460Z (13 days ago)
- Language: Shell
- Size: 198 KB
- Stars: 1,556
- Watchers: 27
- Forks: 70
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fonts - emojify - Emoji on the command line (Emojis)
- awesome-github-star - emojify
README
emojify
=======
Emoji on the command line :scream:
----------------------------------
THIS IS A VERY USEFUL SCRIPT. IT WILL ABSOLUTELY BOOST YOUR PRODUCTIVITY AND
HELP YOU IN YOUR DAILY WORK.
:wink:
Basically, emojify substitutes emoji aliases that many services
(like [GitHub](https://github.com/)) use for emoji raw characters.
Installation
------------
[emojify](emojify) is a shell script, so put it somewhere and make sure it's
added to your `$PATH`.
Here's a one-liner:
```sh
$ sudo sh -c "curl https://raw.githubusercontent.com/mrowa44/emojify/master/emojify -o /usr/local/bin/emojify && chmod +x /usr/local/bin/emojify"
```
If you're on OS X, emojify is also on [Homebrew](http://brew.sh/):
```sh
$ brew install emojify
```
For Arch Linux users, a PKGBUILD is available in the [AUR](https://aur.archlinux.org/packages/emojify/):
```sh
$ pacaur -S emojify
```
Since https://github.com/mrowa44/emojify/pull/18/ emojify requires bash version above 4. The old version can still be
found here: https://github.com/mrowa44/emojify/tree/old_bash_support but it's
not recommended.
Usage
-----
Here's a clever example:
```sh
$ emojify "Hey, I just :raising_hand: you, and this is :scream: , but here's my :calling: , so :telephone_receiver: me, maybe?"
```
would output:
> Hey, I just :raising_hand: you, and this is :scream: , but here's my
> :calling: , so :telephone_receiver: me, maybe?
Or maybe:
```sh
$ emojify "To :bee: , or not to :bee: : that is the question... To take :muscle: against a :ocean: of troubles, and by opposing, end them?"
```
> To :bee: , or not to :bee: : that is the question... To take :muscle: against
> a :ocean: of troubles, and by opposing, end them?
Or you could run it through git log with something like:
```sh
$ git log --oneline --color | emojify | less -r
```
and go from this dull thing:
to this:
To have an alias that does that for you, add something like:
```
log = ! git log --oneline --color | emojify | less -r
```
to your `.gitconfig`.
Note: if you want colors you need to specify the `--color` option.
To invoke help run `emojify -h`.
Contributing
------------
The project can be tested using [bats](https://github.com/sstephenson/bats#installing-bats-from-source):
```bash
$ bats emojify_tests.bats
```
[Shellcheck](https://www.shellcheck.net/) can be used for linting the shell script:
```bash
$ shellcheck --exclude=SC1117 emojify
```
Related
-------
* [pyemojify](https://github.com/lord63/pyemojify) - python port
License
-------
MIT