babarot/emoji-cli

:scream: Emoji completion on the command line

emoji-cli provides input completion for emoji on the command line with an interactive filter.

📝 Description

Emoji (絵文字, Japanese pronunciation: [emodʑi]) are the ideograms or smileys used in Japanese electronic messages and Web pages, that are spreading outside Japan (ref: Katy Perry - Roar (Lyric Video)).

Emoji are funny and make us want to use it 😊. However, it is hard to use it on the command line. This is because the command line don't have input completion for emoji. Therefore, I developed this command line application emoji-cli.

DEMO:

Features

• 😱 Emoji on the command line
• 🌐 Interactive filter
• 🔎 Fuzzy search

Unfortunately, this application supports Z shell only now 🙇.

🔍 Usage

To insert emoji to the command line, type ctrl-s ( ^s ).

$ git commit -m 'This docume^s ...

To collaborate emojify similar to emoji-cli in emoji appication:

echo ":santa^s" | emojify
🎅

📦 Installation

$ git clone https://github.com/b4b4r07/emoji-cli
$ source ./emoji-cli/emoji-cli.zsh

For zplug user:

$ zplug "b4b4r07/emoji-cli"

Dependencies

• jq
• An interactive filter (fzf, peco...)

🍺 Using Homebrew

On macOS you can install the dependencies via Homebrew:

brew install jq fzf peco

🔧 Setup

EMOJI_CLI_DICT

It is defaults to ./dict/emoji.json. EMOJI_CLI_DICT is a path to dictionary of emoji database file. It is written in JSON.

EMOJI_CLI_FILTER

It is defaults to fzf-tmux -d 15%:fzf:peco:percol. EMOJI_CLI_FILTER is the interactive filter command in order to use select emoji. It is separated by colon like the PATH environment variable.

EMOJI_CLI_KEYBIND

It is defaults to ^s (ctrl-s). EMOJI_CLI_KEYBIND is the key binding to start the input completion for emoji.

EMOJI_CLI_USE_EMOJI

Set this variable to non-null to have the widget return the actual emoji

🎫 License

MIT © BABAROT (a.k.a. b4b4r07)

emoji-cli's Issues

Confusion about dependency

The dependency text states that it needs An interactive filter (...) but it seems it needs both the listed ones. Is this the case?

Right now it fails silently if one tries to load it directly like a oh-my-zsh plugin with missing deps and to get the missing deps error one need to source them manually. Is it a convention for plugins to fail silently? If not it would be great to see the errors more clearly

Interactive filters' option

I want to use fzf-tmux -d 20% as the $EMOJI_CLI_FILTER.

For better marketability `EMOJI_CLI_USE_EMOJI=1` should be default imo

title 🙈

Can not work with zplug + ohmyzsh

zplug "b4b4r07/emoji-cli"

can trigger ctrl+s, put cannot paste

I use tmux.

LICENCE link is broken

The link to the LICENCE is broken: https://b4b4r07.mit-license.org/

The licence is fetched to generate a package for ArchLinux (packages must include a licence, after all).

Would you mind just including a file with it in the repo? :)

Thanks!

Recommendation for emoji.json

Which emoji.json works best with this plugin?

Update to Unicode v14

Here's a emoji.json that looks compatible:

https://raw.githubusercontent.com/Julien-Marcou/Unicode-Emoji/master/unicode-emoji.json

Emoji codes (eg :smile:) are inconsistent with "emojify."

Emojify uses different codes to emoji-cli so the example given in the readme file does not always work!

Eg.

So this will not work with oh-my-zsh

Hey sorry I think you may have said this in the README but I just want to clarify, this can't be used with oh-my-zsh?

Pressing ^s while in vim breaks vim :(

literally title again 🤔

Repro steps:

1. Open vim
2. Write sth, i.e in insert mode
3. press ^s
4. vim becomes unresponsive

Support Unicode 7.0 & 8.0

• Unicode 7.0 Emoji List
• Unicode 8.0 Emoji List

Support all races

Support all races.
For example:

:punch::skin-tone-2: :punch::skin-tone-3: :punch::skin-tone-4: :punch::skin-tone-5: :punch::skin-tone-6:

FYI(Japanese): http://japanese.engadget.com/2015/02/23/ios-8-3-os-x/

Does not work

I installed the plugin as mentioned on the README.md and added it to my plugins list. However when I type:

echo "Hey there! :smile:"

It simply prints Hey there! :smile:.

List glitched on Hyper

The list view it's not displayed well as on the standard terminal 🤔

Here a couple of examples:

• 

• 

Some emojis aren't displayed

I don't know why but some emojis aren't displayed when hitting ctrl+Z (I'm using fzf) ... 😞

⬇️, ⬆️, ✨ and probably others

Not works on Arch

Hey,

Thanks for awesome .zsh plug-in! But unfortunately, it didn't work on my Arch. It shows up fwd-i-search: when i press CTRL+S. I installed it via antigen.

Terminal: Alacritty

Thanks

Support search by all aliases

Currently only the first alias seems to be matched against

Sadly my shellscript-foo is horrible so I don't know how to fix it myself

:hankey:
:poop:
:shit:

How do I get ACTUAL emojis into the CLI?

Default usage just prints the name of the emoji -- which kinda defeats the purpose of having an helper to type emojis:

The README explains that piping through emojify works to print a character, but I'm not trying to print one, I'm trying to type one.

E.g.:

git commit -m "First release 🚀"`

Trying to do this via piping to emojify is ridiculously verbose and, well, totally unnatural (especially since I have to jump to the start of the line to add a $( to actually get this to run:

$(git commit -m "First release ^s:pand<Enter>" | emojify)"

Might it be possible to get an environment variable to actually print the selected emoji?
The current form makes usage too complicated (at least IMHO).

Pressing ^s while in terminal, opens `fwd-i-search:`

Pressing ^s while in terminal, opens fwd-i-search:
probably because of keybinding conflict, please help me to fix this.

Have trouble on ubuntu 16.04

Thanks for your brilliant work. I have a problem making the tool work.

After installation when I hit Ctrl+S, nothing appears and the terminal is frozen(double Ctrl-C can exit the status).
following is my zplug config.

zplug "b4b4r07/emoji-cli", on:"junegunn/fzf-bin", if:'(( $+commands[jq] ))'                                                
EMOJI_CLI_FILTER=fzf:peco:percol

I examine the key-binds but seems problem is not here.

$ bindkey | grep "\^S"                                                                                                                      ~
"^S" emoji::cli