Project

gemoji-cli

0.0
The project is in a healthy, maintained state
A command-line tool that: - Converts GitHub emoji codes to Unicode. - Lists supported emojis in Markdown or CSV format.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 3.3.2
>= 1.2.0
>= 4.1.0
 Project Readme

gemoji-cli

🚧 This project is under active development 🚧

A command-line interface for converting emoji codes to Unicode characters and listing available emojis. Built on top of GitHub's gemoji library, this tool provides an easy way to work with emojis in your terminal.

Features

  • 🔄 Convert GitHub-style emoji codes (:emoji_name:) to Unicode characters
  • 📄 List all available emojis in Markdown or CSV format
  • 💻 Cross-platform support

Installation

gem install gemoji-cli

Usage

Filter Emoji Codes

Convert emoji codes in standard input to Unicode characters:

echo "Hello :smile: :wave:" | gemoji filter
# Output: Hello 😊 👋

This will convert all valid emoji codes (:emoji_name:) to their corresponding Unicode characters. Custom emoji codes will remain unchanged.

List All Emojis

Display all available emojis:

gemoji list

By default, this will output a Markdown-formatted table:

| Name | Raw |
|------|-----|
| :smile: | 😊 |
| :wave: | 👋 |
...

You can also get the output in CSV format:

gemoji list --format=csv

This will output:

Name,Raw
:smile:,😊
:wave:,👋
...

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create a new Pull Request

Bug reports and pull requests are welcome on GitHub at https://github.com/sakuro/gemoji-cli.

License

The gem is available as open source under the terms of the MIT License.