https://github.com/xyproto/emojiterm
List and display GitHub emojis directly on the terminal
https://github.com/xyproto/emojiterm
ansi-art ascii-art emoji emojis github github-api terminal utility
Last synced: 5 months ago
JSON representation
List and display GitHub emojis directly on the terminal
- Host: GitHub
- URL: https://github.com/xyproto/emojiterm
- Owner: xyproto
- License: bsd-3-clause
- Created: 2020-03-09T09:48:31.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-12-16T09:57:29.000Z (almost 3 years ago)
- Last Synced: 2025-04-15T23:56:33.249Z (7 months ago)
- Topics: ansi-art, ascii-art, emoji, emojis, github, github-api, terminal, utility
- Language: Go
- Homepage:
- Size: 3.45 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Emojiterm [](https://goreportcard.com/report/github.com/xyproto/emojiterm) [](https://raw.githubusercontent.com/xyproto/emojiterm/main/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.
## 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](https://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:
```bash
GITHUB_TOKEN="asdf" emojiterm -a
```
This can also take an optional search term:
```bash
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:
```bash
alias et='GITHUB_TOKEN="asdf" emojiterm'
```
Replace `asdf` with your own token, that can be generated here: [github.com/settings/tokens](https://github.com/settings/tokens).
## General Info
* Developed on Arch Linux, using Go 1.18.
* Uses [pixterm](https://github.com/eliukblau/pixterm), [imaging](https://github.com/disintegration/imaging), [go-colorful](https://github.com/lucasb-eyer/go-colorful) and [go-github](https://github.com/google/go-github).
* The `display` function in `main.go` is based on code from [pixterm](https://github.com/eliukblau/pixterm) (which is also licensed under `Mozilla Public License 2.0`).
* License: BSD-3
* Version: 0.3.2
* Author: Alexander F. Rødseth <xyproto@archlinux.org>