🚀 gitmoji

A fast, zero-dependency, single-binary tool to create standardized, emoji-based Git commits. Inspired by gitmoji.

✨ Motivation

Gitmoji is a fantastic standard for writing semantic and easily identifiable commits. However, many existing CLI tools require installing large runtimes (like Node.js), global packages (via npm/yarn), and demand extra configuration.

This project solves that by providing a lightweight alternative:

• ✅ Zero dependencies: No Node.js, npm, or Python required.
• ✅ Single binary: Drop it in your path and run it.
• ✅ Blazing fast: Instant execution.
• ✅ Cross-platform: First-class support for Linux, macOS, and Windows.

---

📦 Installation

Simply download the pre-compiled binary for your operating system from the Releases page and make it executable.

🐧 Linux & 🍏 macOS

You can install it quickly via your terminal. Below is an example using the linux-amd64 binary (make sure to replace the artifact name if you are on ARM or macOS):

# 1. Download the latest binary
curl -sSLO https://github.com/edufolly/gitmoji/releases/latest/download/gitmoji-linux-amd64

# 2. Make it executable
chmod +x gitmoji-linux-amd64

# 3. Move it to your binaries directory for global access
sudo mv gitmoji-linux-amd64 /usr/local/bin/gitmoji

Available UNIX Artifacts:

• gitmoji-linux-amd64
• gitmoji-linux-arm64
• gitmoji-macos-intel
• gitmoji-macos-silicon

🪟 Windows

1. Download gitmoji-windows-amd64 from the latest release.
2. Rename the downloaded file to gitmoji.exe.
3. Move it to a directory that is included in your system's PATH environment variable.

🛠 Usage

Using gitmoji is incredibly straightforward. Navigate to your git repository, stage your files if necessary, and run:

gitmoji

The interactive CLI will guide you through a simple three-step process:

1. Choose a Gitmoji: Type to filter the list and use your keyboard (Up/Down arrows) to select the most appropriate emoji for your commit. Press Enter to confirm.
2. Inform commit title: Type a short, descriptive title for your commit. The CLI includes a helpful character counter (e.g., [00/47]) to ensure your titles remain concise and readable.
3. Inform commit body: (Optional) Add a more detailed description of your changes. If you don't need a body, simply press Enter to skip.

Once completed, the tool automatically executes the commit command under the hood (e.g., git commit -a -m "✨ your title" -m "your body").

Quick Search

If you already know which emoji or category you want to use, you can pass a search term directly as an argument to skip the initial filtering step:

gitmoji bug

If your search term yields exactly one match, gitmoji will auto-select it and jump straight to the commit title prompt!

Options

• gitmoji --version : Displays the current version of the tool.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes using gitmoji!
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.