# git-kermit

> ![npm](https://img.shields.io/npm/v/git-kermit?color=76FF03)

Latest version **1.0.10** (published 2022-03-01) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install git-kermit
pnpm add git-kermit
yarn add git-kermit
bun add git-kermit
```

Provides the command `kermit`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2022-03-01 |
| First published | 2022-01-16 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 18.2 KB |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ethan Hsu |
| Maintainers | ethanhsuhsu |

## Links

- npm: https://www.npmjs.com/package/git-kermit
- npm.io page: https://npm.io/package/git-kermit

## Dependencies (2)

- [inquirer](https://npm.io/package/inquirer.md) ^8.2.0
- [simple-git](https://npm.io/package/simple-git.md) ^2.48.0

## Recent versions

- 1.0.10 (latest) — 2022-03-01
- 1.0.9 — 2022-03-01
- 1.0.8 — 2022-03-01
- 1.0.7 — 2022-02-26
- 1.0.6 — 2022-01-31
- 1.0.5 — 2022-01-31
- 1.0.4 — 2022-01-16
- 1.0.3 — 2022-01-16
- 1.0.2 — 2022-01-16
- 1.0.1 — 2022-01-16
- 1.0.0 — 2022-01-16

## README

![npm](https://img.shields.io/npm/v/git-kermit?color=76FF03)

![Sippin](https://user-images.githubusercontent.com/24931732/154041469-7df2baad-c8ee-4c0c-a17e-63d7626ef40f.gif)

# Kermit
Quickly generate conventional commits using the command line.


## Inspiration
Using [conventional commits styling](https://www.conventionalcommits.org/en/v1.0.0/) makes a git history much more organized and readable.
However, creating conventional commit messages from scratch can be a nightmare. Luckily, the kermit CLI is here to save the day and make commit messages fun again!

## Installation
Kermit is hosted as an npm package, so you will need to have [Node.js](https://nodejs.org/en/) installed beforehand.
```bash
sudo npm install -g git-kermit # Install git-kermit from npm

# Configure the git kermit alias
git config --global alias.kermit '!sh -c '\''kermit -g "$0" "$@"'\'''
```
## Usage
There are two ways to generate commit messages:
* `git kermit` creates a git commit with the generated message
* `kermit` prints out the generated messsage

Kermit uses an inuitive form built with [Inquirer.js](https://www.npmjs.com/package/inquirer) to build commit messages in a user-friendly way.

<img width="322" alt="Screen Shot 2022-02-15 at 2 31 16 AM" src="https://user-images.githubusercontent.com/24931732/154043866-46cd428a-afbc-4e66-8f2d-67023915f956.png">

## Features
* Automatically caches the last used commit scope (can be ignored by entering a space " " for the commit scope)
* Breaking changes can be added with the `-b` flag
* All fields are input validated
* `git kermit` supports argument passthrough so flags like `--amend` and `-a` still work
* Supports prekermit (precommit) hooks. If a prekermit hook fails, then kermit will not start the form. 

## Contributing
This project is small, but plays an important role for teams that use conventional commits. Feel free to add issues or pull requests suggesting new functionality!

---
_Source: https://npm.io/package/git-kermit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._