commitizen-cli

Commitizen CLI

Command-line interface tool that helps enforce standardized commit message formats in Git repositories.

Features

• Standardized Commit Messages: Enforce consistent commit message structure by guiding users through prompts and validating against specified formats.
• Conventional Commit Support: Easily generate commit messages following popular commit conventions like Conventional Commits.
• User-Friendly Interface: Interactive prompt-based interface for creating compliant commit messages without worrying about format details.
• Integration with Git: Seamlessly commit changes directly from the CLI, ensuring compliance with the chosen commit message convention.
• Emoji Support: Add emojis to your commit messages to express the nature of the changes or provide additional context.
• Ticket Support: Set ticket reference to your commit messages to link directly the changes with your task.

Installation

To install commitizen-cli, use:

npm install -g commitizen-cli

or if you don't like to install it globaly, use:

npx commitizen-cli

Usage

Navigate to your Git repository.

Run the following command:

commitizen-cli

or use the minified command:

cocli

Update

To update to the latest version, use:

commitizen-cli update

or using the minified command:

cocli update

Follow the prompts to generate a standardized commit message.

The CLI will execute the Git command to commit your changes with the generated message.

Support

Commitizen CLI is an MIT-licensed open source project. It can grow thanks to the sponsors and support.

License

Commitizen CLI is MIT licensed.