🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

gitmoji-cli

Package Overview
Dependencies
Maintainers
1
Versions
121
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gitmoji-cli

A gitmoji client for using emojis on commit messages.

1.5.0
Source
npm
Version published
Weekly downloads
13K
-11.29%
Maintainers
1
Weekly downloads
 
Created
Source

gitmoji-cli

Travis Build Status David Dependencies npm version gitmoji badge XO code style npm downloads

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
	--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	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

gitmoji commit

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

gitmoji config

Keywords

gitmoji

FAQs

Package last updated on 25 Mar 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts