README

gitmoji-cmd

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-cmd solves the hassle of searching through the gitmoji list. Includes a bunch of options you can play with! :tada:

Install

npm

$ npm i -g gitmoji-cmd

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-cmd preferences.
    --commit, -c    Interactively commit using the prompts
    --list, -l      List all the available gitmojis
    --search, -s    Search gitmojis
    --version, -v   Print gitmoji-cmd 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

⚠️ The hook should not be used with the gitmoji -c command.

gitmoji commit

Search

Search using specific keywords to find the right gitmoji.

$ gitmoji bug linter -s

gitmoji list

List

Pretty print all the available gitmojis.

$ gitmoji -l

gitmoji list

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-cmd preferences, such as the auto git add . feature.

gitmoji config

Usage no npm install needed!