GitGud CLI

This repository is cross-platform CLI (Command Line Interface) for the GitGud modular git model. It contains a series of commands that help you use git more quickly and following the model.

• GitGud CLI
  • Installation
  • Usage
    • Commit Module
      • Flags
      • Full commit
      • Generate
    • Flow Module
      • Flow Init
      • Flow Start
  • Compiling
  • Contributing

Installation

Just download and drop the latest release into a folder, add it to your path and call the executable in your terminal of preference.

Usage

Using it is rather simple, after you have it on your path you can call it using: gitgud <module> <subcommand>

The commands are divided into modules, just like the original model, the ones available at the moment are:

Commit Module

This module is equivalent to the Commit submodel

This command is a wrapper around the git commit -m, which means that you can use the flags -a and --amend

gitgud commit -m "Commit subject"
gitgud c -m "Commit subject"

Flags

The following flags can be used:

• -a or --all : Equivalent to the same flag in git
• --amend : Equivalent to the same flag in git
• -m : Equivalent to the same flag in git
• -d or --domain : Add a domain to the commit (an impacted area of the code)
• -q or --quick : Don't ask for missing parts of the commit if none is provided (Only the domain in that case)

Full commit

The full commit subcommand is a variation of the base command that will generate a complete commit message (with body and footer)

gitgud commit full -m "Commit subject"
gitgud commit f -m "Commit subject"

The following flags can be used after the subcommand:

• -b or --body : Specify the text of the body of the commit
• -c or --closes : Specify a list of closed issues by the commit
• -s or --see : Specify a list of referenced issues by the commit

Generate

This subcommand will simply generate a commit message, without actually committing anything

gitgud commit generate
gitgud c gen

All flags from the full commit command can be used

Flow Module

This module is equivalent to the Flow submodel

Flow Init

The init command will initialize a new local Git repository and create the stable branch, if a repository is already found in the folder, it will instead only create the stable branch, additionally, if the --remote or -r flag is provided, it will automatically add the origin remote and push the local repository to it

gitgud flow init --remote 'git@github:User/Repo.git'
gitgud f init -r 'git@github:User/Repo.git'

Also, the --defaultBranch flag can be provided to change the default name

Flow Start

The start command will create a new branch with the prefixed type, which can be selected from a list. The branch name can be provided via the --branchName or -b flag, otherwise it will be asked during the process

gitgud flow start --branchName 'my-feature-branch'
gitgud f start -b 'my-feature-branch'

Compiling

You are welcome to clone and compile this repository. For this you will need Go on the latest version and compile it from the terminal using:

go -o gitgud

Contributing

You are more than welcome to contribute to this repository opening issues and pull requests, just remember to follow the specifications of the GitGud model, as this repository follows all of it (obviously).