gitmoji-cli

gitmoji-cli

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
  	--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	Update the gitmoji.json cache.

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 # this will create the .git/hook/prepare-commit-msg
$ git add .
$ git commit

Search

Search using specific keywords to find the right gitmoji.

$ gitmoji bug linter -s

List

Pretty print all the available gitmojis.

$ gitmoji -l

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