rcz 0.4.15

A tool to write a commit message
rcz-0.4.15 is not a library.


A tool to write a commit message based on Conventional Commits
inspired by git-cz


cargo install rcz


# bash
function gitz() {
  if local output=$(rcz); then
    git commit -m "${output}"
    echo "Err: failed to generate a commit message"


The configuration file will be automatically generated on:

  • Linux: ~/.config/rcz
  • Windows: {FOLDERID_RoamingAppData}\rcz
  • Mac OS: ~/Library/Preferences/rs.rcz
format = '''
{type}: {subject}'''

description = 'A bug fix'
value = 'fix'
emoji = '๐Ÿ›'

description = 'A new feature'
value = 'feat'
emoji = 'โœจ'

description = 'Changes that introduces a breaking API change'
emoji = '๐Ÿ’ฅ'

description = 'build system or external dependencies'
value = 'chore'
emoji = '๐Ÿ› ๏ธ'

description = 'CI related changes'
value = 'ci'
emoji = '๐Ÿ’ซ'

description = 'Documentation only changes'
value = 'docs'
emoji = 'โœ๏ธ'

description = 'Changes that do not affect the meaning of the code'
value = 'style'
emoji = '๐Ÿ’„'

description = 'A code change that neither fixes a bug nor adds a feature'
value = 'refactor'
emoji = '๐Ÿงน'

description = ' A code change that improves performance'
value = 'perf'
emoji = '๐Ÿš„'

description = 'Adding or correcting tests'
value = 'test'
emoji = '๐Ÿงช'


All section etc {scope} that you can add on the format are bellow.

  • {type}
  • {emoji}
  • {description}

:warning: The string that enclosed in double brackets ({{echo 'foo'}}, {{date}} etc) is interpreted as shell script.

Other strings ({body}, {footer}, {header} etc) is interpreted as a custom input.
The string is used as a prompt message.

A example for your customize is bellow.

format = '''
{type}{scope}: {emoji}{subject}