gitmoji-cli definition ¶

README.md ¶

gitmoji-cli ¶

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 # this will create the .git/hooks/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

Config ¶

Run gitmoji -g to setup some gitmoji-cli preferences, such as the auto git add . feature.