gitgo

README

gitgo

git management, format commit message and customization

Commands

This CLI will usage syntax as gitgo [<global option>] [command] [subcommand] [<option>] arguments...

Initial

Details

Description

For initial git, same as git init

Example usage

• gitgo init
• gitgo i

Options	Description
--force | -f	Force reinitial git

Destory

Details

Description

Delete git repo, remove .git folder

Example usage

• gitgo destroy
• gitgo d

Options	Description
--force | -f	Force delete without prompt

Status

Details

Description

Show git status, same as git command git status

Example usage

• gitgo status
• gitgo s

Options	Description
--force | -f	Force delete without prompt

Configuration

Details

Description

Manage cli configuration

Example usage

• gitgo configuration
• gitgo config
• gitgo g

Actions

• gitgo config - open configuration file by default text-editor (use environment variable call $EDITOR)
• gitgo config location|l - show current location of configuration file
• gitgo config --key <key> - get value in config file by key
• gitgo config --key <key> --value <value> - set value into config file

Options	Description
--key | -k	Input config key, separate layer by .
--value | -v	Input config value, use only want to save new value

Example Configuration

By default configuration folder will be on

• Default ~/.config/github.com/kamontat/gitgo/config/
• Also able to get from $GOPATH/src/github.com/kamontat/gitgo/config/

config:
    commit:
        type: text # text | emoji
        emoji: string # string | emoji
        key:
            require: true # true | false 
        title:
            require: true # true | false 
            auto: false # true | false
            size: 50 # maximum charecter size
        message:
            require: true # true | false 
        showsize: 8 # list when show the 'commit list'
    editor: '' # vim | nano | other cli..

Extra

This syntax of key is separate by dot, e.g. config.editor, config.commit.key etc.

Add

Details

Description

Add file/folder to git, similar with git add <args>

Example usage

• gitgo add
• gitgo a

Actions

• gitgo add <args> - add (files or folder) into git
• gitgo add all|a - add every files and folders into git
• gitgo add --all|-A - same as gitgo add all

Options	Description
--all | -A	Add every files and folders to git

Commit

Details

Description

Git commit with default format and custom syntax. Next plan this will able to custom git message format.

Example usage

• gitgo commit
• gitgo c

Actions

• gitgo commit - commit with config type and this will prompt information to user, for generating commit message
• gitgo commit emoji|moji|e - commit message with emoji type
• gitgo commit text|t - commit message with text type

Create commit with special actions

• gitgo commit initial|init|i - generate initial commit with default message and commit config type
• gitgo commit release|r - generate release commit with default message, including auto generate git tag
• gitgo commit emoji|moji|e initial|init|i - initial commit message with emoji type
• gitgo commit emoji|moji|e release|r - create release commit message with emoji type
• gitgo commit text|t initial|init|i - initial commit message with text type
• gitgo commit text|t release|r - create release commit message with text type

Options	Description
--add | -a	Include add option into commit (git -am "")
--all | -A	Run git add --all command, before commit code
--key | -k	Add commit key to commit message
--title | -t