Skip to content

5n7/gmoji

Repository files navigation

banner

release license go version release

A Go implementation of gitmoji-cli

gitmoji is an emoji guide for commit messages.
This repository is a Go implementation of gitmoji-cli, a CLI application of gitmoji.
This application does not require the Node.js environment and is fast enough as compared to the original, which is a JavaScript implementation.

Usage

> gmoji help
gmoji is a Go Implementation of gitmoji-cli.

Usage:
  gmoji [flags]
  gmoji [command]

Available Commands:
  copy        Copy the commit message to the clipboard
  help        Help about any command
  hook        Set the commit hook
  init        Download the list of gmojis
  list        Show the list of gmojis
  version     Show version

Flags:
  -h, --help          help for gmoji
      --hook string   hook path (.git/COMMIT_EDITMSG)
  -V, --version       show version

Use "gmoji [command] --help" for more information about a command.

Basic Usage

# Download the list of gmojis for the first time only.
gmoji init

# After initializing git project, set commit hook.
git init
gmoji hook

# Add the file, commit it, and gmoji runs up automatically.
git add .
git commit

Install

Binary

Get binary from releases.
If you already have jq and fzf or peco, you can download binary by running the following command.

curl -Ls https://api.github.com/repos/skmatz/gmoji/releases/latest | jq -r ".assets[].browser_download_url" | fzf | wget -i -

Source

go get github.com/skmatz/gmoji/...