https://github.com/sousandrei/cc-cli

handy git-hook and cli for conventional commits
https://github.com/sousandrei/cc-cli

cli command-line conventional-commits git git-hook git-hooks hacktoberfest rust

Last synced: 3 months ago
JSON representation

handy git-hook and cli for conventional commits

• Host: GitHub
• URL: https://github.com/sousandrei/cc-cli
• Owner: sousandrei
• License: mit
• Created: 2021-08-16T03:34:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T14:44:19.000Z (10 months ago)
• Last Synced: 2024-04-25T15:52:04.485Z (10 months ago)
• Topics: cli, command-line, conventional-commits, git, git-hook, git-hooks, hacktoberfest, rust
• Language: Rust
• Homepage:
• Size: 2.37 MB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cc-cli

**Conventional Commits hook and cli**

[![Build Status](https://img.shields.io/github/actions/workflow/status/sousandrei/cc-cli/main.yaml?branch=main)](https://github.com/sousandrei/cc-cli/actions)

[![crates.io version](https://img.shields.io/crates/v/cc-cli.svg?style=flat-square)](https://crates.io/crates/cc-cli)



## About

Easy cli and git-hook to help with following the [Conventional Commits](https://conventionalcommits.org/en/v1.0.0/) specification

Heavily inspired by [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli)

## Install

using cargo

```bash

cargo install cc-cli

```

## Usage

```

cc-cli --help

```

```

Usage: cc-cli [] [-i] [-r]

Easy peasy Conventional Commits

Options:

  -i, --hook        hooks your commits

  -r, --unhook      removes the hook

  --help            display usage information

```

You can install the git-hook using

**NOTE:** the hook is installed in a per-repository basis

```

cc-cli -i

```

Or use it via cli with no parameters

```

cc-cli

```

To remote the hook, simply type

```

cc-cli -r

```