A gitmoji interactive client for using gitmojis on commit messages.
This project provides an easy solution for using gitmoji from your command line. Gitmoji-cli solves the hassle of searching through the gitmoji list. Includes a bunch of options you can play with! :tada: And it is a shameless copy of the original but written in Rust.
bash
$ cargo install gitmoji-cli
bash
$ gitmoji --help
``` A gitmoji interactive client for using gitmojis on commit messages.
USAGE: gitmoji [FLAGS] [OPTIONS]
FLAGS: -c, --commit Interactively commit using the prompts -g, --config Setup gitmoji-cli preferences -h, --help Prints help information -i, --init Initiliaze gitmoji as a commit hook -l, --list List all the available gitmojis -r, --remove Remove a previously initialized commit hook -u, --update Sync emoji list with the repo -V, --version Prints version information
OPTIONS:
-s, --search
You can use the commit functionality in two ways, directly or via a commit-hook.
Start the interactive commit client, to auto generate your commit based on your prompts.
bash
$ gitmoji -c
Run the init option, add your changes and commit them, after that the prompts will begin and your commit message will be built.
bash
$ gitmoji -i
$ git add .
$ git commit
⚠️ The hook should not be used with the gitmoji -c command.
Search using specific keywords to find the right gitmoji.
bash
$ gitmoji -s bug
Pretty print all the available gitmojis.
bash
$ gitmoji -l
Update the gitmojis list, by default the first time you run gitmoji, the cli creates a cache to allow using this tool without internet connection.
bash
$ gitmoji -u
Run gitmoji -g to setup some gitmoji-cli preferences, such as the auto git add . feature.