Skip to content

CLI to help write commit messages according to conventional commits.

Notifications You must be signed in to change notification settings

nicosantux/stx-commit

Repository files navigation

stx-commit

CLI to help write commit messages according to conventional commits.

Installation

If you want to install stx-commit into your project:

npm:

npm install -D stx-commit

pnpm:

pnpm add -D stx-commit

yarn:

yarn add -D stx-commit

bun:

bun add -D stx-commit

Then add into your package.json:

{
  "scripts": {
    "commit": "stx-commit"
  }
}

CLI Options

Option Description Default
-ml --max-length Max length of each line. 72
-e --emoji Add the selected commit type emoji into the commit title. false