gitmoji-cli
![gitmoji badge](https://img.shields.io/badge/gitmoji-%20%F0%9F%98%9C%20%F0%9F%98%8D-FFDD67.svg?style=flat-square)
![gitmoji-cli](https://cloud.githubusercontent.com/assets/7629661/20454643/11eb9e40-ae47-11e6-90db-a1ad8a87b495.gif)
A gitmoji interactive client for using gitmojis on commit messages.
About
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:
Install
$ npm i -g gitmoji-cli
Usage
$ gitmoji --help
A gitmoji interactive client for using gitmojis on commit messages.
Usage
$ gitmoji
Options
--init, -i Initialize gitmoji as a commit hook
--remove, -r Remove a previously initialized commit hook
--config, -g Setup gitmoji-cli preferences.
--commit, -c Interactively commit using the prompts
--list, -l List all the available gitmojis
--search, -s Search gitmojis
--version, -v Print gitmoji-cli installed version
--update, -u Sync emoji list with the repo
Commit
You can use the commit functionality in two ways, directly or via a commit-hook.
Client
Start the interactive commit client, to auto generate your commit based on your prompts.
$ gitmoji -c
Hook
Run the init option, add your changes and commit them, after that the prompts will begin and your commit message will be built.
$ gitmoji -i
$ git add .
$ git commit
![gitmoji commit](https://cloud.githubusercontent.com/assets/7629661/20454513/5db2750a-ae43-11e6-99d7-4757108fe640.png)
Search
Search using specific keywords to find the right gitmoji.
$ gitmoji bug linter -s
![gitmoji list](https://cloud.githubusercontent.com/assets/7629661/20454469/1815550e-ae42-11e6-8c23-33ab7a3e48a3.png)
List
Pretty print all the available gitmojis.
$ gitmoji -l
![gitmoji list](https://cloud.githubusercontent.com/assets/7629661/20454472/1c351e6c-ae42-11e6-8f3c-da73429d8eff.png)
Update
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.
$ gitmoji -u
Config
Run gitmoji -g
to setup some gitmoji-cli preferences, such as the auto git add .
feature.
![gitmoji config](https://cloud.githubusercontent.com/assets/7629661/23577826/82e8745e-00c9-11e7-9d7e-623a0a51bff9.png)