{"repo":"commitizen/cz-cli","free":true,"listed":false,"github":"https://github.com/commitizen/cz-cli","clone":"git clone https://github.com/commitizen/cz-cli.git","description":"The commitizen command line utility. #BlackLivesMatter","language":"JavaScript","stars":17498,"topics":["commitizen","javascript","commit-hooks","node","semantic-versioning","semantic-release","command-line","utilities","commitizen-adapter","git"],"license":"MIT","category":"cli-tools","readme_excerpt":"Commitizen for contributors When you commit with Commitizen, you'll be prompted to fill out any required commit fields at commit time. No more waiting until later for a git commit hook to run and reject your commit (though that can still be helpful). No more digging through CONTRIBUTING.md to find what the preferred format is. Get instant feedback on your commit message formatting and be prompted for required fields. Installing the command line tool Commitizen is currently tested against Node.js 12, 14, & 16, although it may work in older versions of Node.js. You should also have npm 6 or greater. Installation is as simple as running the following command (if you see EACCES error, reading fixing npm permissions may help): Using the command line tool If your repo is Commitizen friendly: Simply use git cz or just cz instead of git commit when committing. You can also use git-cz , which is an alias for cz . Alternatively , if you are using npm 5.2+ you can use npx instead of installing globally: or as an npm script: When you're working in a Commitizen-friendly repository, you'll be prompted to fill in any required fields, and your commit messages will be formatted according to the standards defined by project maintainers. If your repo is NOT Commitizen friendly: If you're not working in a Commitizen-friendly repository, then git cz will work just the same as git commit , but npx cz will use the streamich/git-cz adapter. To fix this, you need to first make your repo Commitizen fr","default_branch":null,"files":null,"tree":[],"storefront":"/r/commitizen","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/commitizen/cz-cli/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}