Emoji Toolkit

Get emoji images or data URLs from your terminal for notifications, scripts, and everyday tools. 🎣

Pick a vendor, look up a shortcode, and use the artwork anywhere.

Install 💿

Requires Python 3.11+ and uv or pipx.

uv tool install git+https://github.com/AdrieanKhisbe/emoji-toolkit.git@v0.1.0
# Or use pipx:
pipx install git+https://github.com/AdrieanKhisbe/emoji-toolkit.git@v0.1.0

emoji install --vendor apple

Use it 🏉

emoji smiley                         # original PNG path
# /Users/ak/.local/share/emojies/vendors/apple/grinning_face_with_big_eyes.png
emoji smiley --url                   # PNG preview data URL
# data:image/png;base64,iVBOR.....RK5CYII=

emoji wave --skin-tone dark          # choose a skin tone
emoji smiley --vendor google         # choose a vendor
emoji list hand                      # discover shortcodes

Shortcodes follow GitHub aliases. Colons are optional: smiley and :smiley: work the same way. 😃 Paths point to original images; data URLs contain small previews, up to 72×72 pixels.

Your first installed vendor becomes the default. Change it or save a skin tone:

emoji config set vendor apple
emoji config set skin-tone dark
emoji install --update                 # refresh installed artwork
emoji status                           # show installed vendors and versions

See all commands and options.

Pick your artwork 🌈

Different Emoji images vendors are provided Pick one:

• apple: Apple
• emojione: JoyPixels
• facebook: Facebook
• google: Google Noto Color Emoji
• samsung: Samsung
• twitter: Twitter / X
• windows: Microsoft Windows

emoji install --vendor google --vendor twitter
emoji install --all

The same 😃 :smiley:, drawn by each vendor:

Vendor	Smiley
Apple
JoyPixels
Facebook
Google
Samsung
Twitter / X
Microsoft Windows

Explore the dataset 🗺️

The checked-in artwork lives in resources/dataset:

• dataset.json — the shared Unicode index.
• vendors/<vendor>.json — image paths, preview data URLs, and source metadata.
• images/<vendor>/ — original artwork.

Join vendor records to the index by their unicode sequence. Reading the JSON and images requires no Python dependencies.

See dataset maintenance and publishing resource bundles.

Contribute 🤝

From a checkout, use Python 3.11+ and Poetry 2+:

poetry install
poetry run poe local-install            # install Apple artwork from this checkout
poetry run poe format
poetry run poe format-check
poetry run poe typecheck
poetry run poe test

Have a bug or an idea? Open an issue. For artwork problems, include the emoji and vendor.

License

Project code is licensed under MIT. Vendor artwork retains its respective copyrights and licenses; see Emojipedia's licensing guide.