Easily add emojis to your git commit messages 😎

Zeeshan Ali Khan

Last update: May 29, 2023

Related tags

Utilities gimoji

Overview

gimoji

A CLI tool that makes it easy to add emojis to your git commit messages. It's very similar to (and is based on) gitmoji-cli but written in Rust.

Installation

cargo install -f gimoji

Usage

gimoji is primarily intended to be used as a git commit hook. Once installed, ask gimoji to install the hook in your respositry:

cd /path/to/your/project/
gimoji --init

Now, whenever you run git commit, gimoji will kick in and prompt you to choose an emoji.

If you launch gimoji directly without any arguments, it will prompt you to choose an emoji and then copy your choice to the system clipboard.

Use --help to see all the available options.

Updating the emoji cache

On the first run, gimoji will download the emoji list from gitmoji and cache it locally. If you want to update the cache, run:

gimoji --update-cache

Rationale

gitmoji-cli while being a great tool, can be considerably slow. Hence this project. gimoji has a few differences:

it will launch a full-screen terminal UI to choose an emoji, hence emojis on the console.
it will only add an emoji to the commit if it's a completely new commit without any existing message (e.g it won't kick in when a message is already specified through -m option of git commit, or when ammending a commit).
it does not add anything other than an emoji (like scope, summary etc.) to the commit message and lets you do that in your preferred editor.

The philosophy here is to enable you to quickly and easily choose an emoji and get out of your way.

License

MIT

You might also like...

Hosts EDitor, it will add/update/delete host entries for you

Host EDitor A command-line tool to easily manage you hosts file. View Demo · Report Bug · Request Feature Table of Contents About The Project Built Wi

10 Nov 2, 2022

Easily sync your clipboard between devices. This is a work in progress app.

Clipboard Sync Description Easily sync your clipboard between devices. This is a work in progress app. Stack Frontend: React Tauri isomorphic-ws TSX,

2 Mar 2, 2022

Verify that registry crates in your Cargo.lock are reproducible from the git repository

cargo-goggles Verify that registry crates in your Cargo.lock are reproducible from the git repository. This cargo subcommand analyzes the following pr

36 Jul 16, 2024

Better error messages for axum framework.

axum-debug This is a debugging crate that provides better error messages for axum framework. axum is a great framework for developing web applications

3 Feb 3, 2022

Log defmt messages over the serial port.

defmt-serial A defmt target for logging over a serial port. Messages can e.g. be read using socat and passed through defmt-print, see example-artemis

10 Oct 5, 2022

A low-ish level tool for easily writing and hosting WASM based plugins.

A low-ish level tool for easily writing and hosting WASM based plugins. The goal of wasm_plugin is to make communicating across the host-plugin bounda

62 Sep 20, 2022

Annotation to easily define ad-hoc / one-shot extension traits

2 Apr 19, 2022

Convert Hygea calendar to an iCal file to easily import it to Google Calendar (Rust version)

Hygea to iCal Goal Hygea provides a calendar via PDF and an application called Recycle. I just wanted to use an iCal file to import it in my calendar.

2 Oct 28, 2021

PM-Tools - a simple Rust util to easily create server directories

PM-Tools PM-Tools is a simple Rust util to easily create server directories or plugins without the hassle of unzipping or creating directories Progres

2 Mar 19, 2022

Comments

🔥 Remove exec line from git hook

I copied over that line from the git hook gitmoji-cli installs and still not sure what it does. I had assumed it's needed but it seems it isn't.

Also while I don't know if the git hook works on Windows at all, this line will very likely fail there.

opened by zeenix 14

On Mac git hook does not work

The hook ends up with the following output:

+ exec
+ gimoji --hook .git/COMMIT_EDITMSG
Error: Custom { kind: Other, error: "Failed to initialize input reader" }

bug question

opened by rimbi 2

There seems to be something wrong with the alembic

I copied alembic ⚗️ to the clipboard and then pasted it to the console (iterm2) and here is what I see:

That does not happen with, for instance, lock icon:

Also, it looks ok when I paste the alembic to another medium, such as here: ⚗️

One more thing: I have noticed that with lock, there is a space between the icon and to in the message Copied 🔒️ to the clipboard, while with alembic it does not exist.

opened by rimbi 1
Show progress of emoji download

Although the database is a 10K file, it could still take a few seconds on a congested/slow network. It would be good to show progress is possible. ratatui has two widgets we can use for showing the progress.

opened by zeenix 0

Releases(0.3.0)

0.3.0(May 25, 2023)

✨ Copy the selected emoji to the clipboard in standalone mode (#7). 🚸 Case-insensitive search for emojis (#9). ➕ Depend on arboard. ➕ Depend on regex crate.
Source code(tar.gz)
Source code(zip)
0.2.0(May 24, 2023)

🚸 Esc key for clearing the search & quitting the app 📝 Specify path to the screenshot in the README. 🚸 Ensure search entry gets enough space 📦️ Add missing data to Cargo.toml file 🩹 Fix typo in link name
Source code(tar.gz)
Source code(zip)
0.1.0(May 23, 2023)

Source code(tar.gz)
Source code(zip)