Skip to content

A CLI tool for interactive, Conventional Commits compliant Git commits

License

Notifications You must be signed in to change notification settings

13OnTheCode/commit-x

Repository files navigation

Commit-X

NPM version License

English | 简体中文

a command-line tool that allows you to interactively generate Git commit messages that comply with the Conventional Commits specification and automatically commit them

commit-x

Features

  • User-friendly interactive interface
  • No upfront configuration, no adapters required, no extra steps
  • Automatic validation of commit messages to ensure compliance with the specification, with error messages and suggestions

Install

Global

For global access and ease of use, it's recommended to install commit-x globally on your system:

npm install commit-x -g

Project-Specific

If you prefer project-specific installations:

npm install commit-x --save-dev

Usage

Run the following command in your terminal:

commit-x

Follow the prompts to fill in the commit message details, and it will be automatically committed to your Git repository

License

MIT License © 2023-PRESENT 13OnTheCode

About

A CLI tool for interactive, Conventional Commits compliant Git commits

Resources

License

Stars

Watchers

Forks