Giter Club home page Giter Club logo

git-conventional-cli's Introduction



Git Conventional CLI


Git Conventional CLI

Version License npm dependents




Features

  • Easy install
  • Follows the conventional commit guidelines
  • Pretty prints preview in color
  • Works globally or in your repository
  • List of untracked and modified files easly
  • Reset commit easly

CLI Usage

CLI Installation

NPM Yarn
npm install --global git-conventional-cli
yarn global add git-conventional-cli

CLI Quickstart

To quickstart runs above command and follow the instructions:

gcc

CLI Helper

gcc summary? description? [options?]

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚                                             โ”‚
โ”‚   ๐Ÿค– Git Conventional Commit the easy way   โ”‚
โ”‚                                             โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Arguments:
  summary                      Summary of the current commit
  description                  Description of the current commit (Max-Length: 72 char)

Options:
  -V, --version                output the version number
  -s, --scope <value>          Scope of type commit
  -t, --type <value>           Conventional Type (choices: "feat", "fix", "style", "refactor", "test", "docs", "chore", "perf")
  -h, --help                   display help for command

Commands:
  log                          Log of last commits
  unt                          List of untracked files
  mod                          List of modified files
  rst <type> <hash-or-number>  Undo local changes to the repository using the reset comman | Possible types: h (hard), s (soft), m (mixed)

CLI Inline use

Inline example usage:

gcc -t "fix" -s "user" "this sumary of commit" "this a description of the commit"

Contributing

Contribute by opening a pull request. Also, if your pull request contains patches or new features, you must include relevant unit tests.

Maintainers

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.