Skip to content

List and display GitHub emojis directly on the terminal

License

Notifications You must be signed in to change notification settings

xyproto/emojiterm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Emojiterm Go Report Card License

  • Do you want to find a suitable Emoji for use on GitHub, using only a terminal that supports 256 colors?
  • Then this application is for you.

emojiterm can list all available emoji names, or search for a keyword and display the emoji directly on the terminal.

recording

Requirements

  • Go >= 1.10.
  • A terminal emulator that supports 256 colors.

Installation

Install with your favorite package manager, if possible.

Manual installation of the development version

go get -u github.com/xyproto/emojiterm

Supported terminal emulators

These terminal emulators are known to work:

  • konsole
  • xfce4-terminal

This one does not work:

  • urxvt

This one works, but does not look quite right:

  • st

Request limit

If you reach the request limit for using the GitHub API, placing a valid token in the GITHUB_TOKEN environment variable should solve the issue.

For generating a token, just visit github.com/settings/tokens and click "Generate new token". None of the boxes with extra access needs to be checked, since emojiterm only fetches emoji-related information.

Slideshow

You can display a slideshow of all available GitHub emojis with the following command:

GITHUB_TOKEN="asdf" emojiterm -a

This can also take an optional search term:

GITHUB_TOKEN="asdf" emojiterm -a cat

Setting up an alias

One way of using emojiterm is through an alias, that also sets the GITHUB_TOKEN, like this:

alias et='GITHUB_TOKEN="asdf" emojiterm'

Replace asdf with your own token, that can be generated here: github.com/settings/tokens.

General Info