https://github.com/5n7-sk/gmoji
A Go implementation of gitmoji-cli
https://github.com/5n7-sk/gmoji
git gitmoji gitmoji-cli
Last synced: 2 months ago
JSON representation
A Go implementation of gitmoji-cli
- Host: GitHub
- URL: https://github.com/5n7-sk/gmoji
- Owner: 5n7-sk
- License: mit
- Created: 2020-07-05T11:20:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-26T18:22:06.000Z (almost 4 years ago)
- Last Synced: 2026-01-12T05:26:14.668Z (2 months ago)
- Topics: git, gitmoji, gitmoji-cli
- Language: Go
- Homepage:
- Size: 65.4 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**A Go implementation of [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli)**
[gitmoji](https://github.com/carloscuesta/gitmoji) is an emoji guide for commit messages.
This repository is a Go implementation of [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli), a CLI application of [gitmoji](https://github.com/carloscuesta/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
```sh
> gmoji help
```
```console
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
```sh
# 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](https://github.com/skmatz/gmoji/releases).
If you already have [jq](https://github.com/stedolan/jq) and [fzf](https://github.com/junegunn/fzf) or [peco](https://github.com/peco/peco), you can download binary by running the following command.
```sh
curl -Ls https://api.github.com/repos/skmatz/gmoji/releases/latest | jq -r ".assets[].browser_download_url" | fzf | wget -i -
```
### Source
```sh
go get github.com/skmatz/gmoji/...
```