{"id":27334401,"url":"https://github.com/cassin01/rcz","last_synced_at":"2025-10-26T17:03:48.250Z","repository":{"id":59931845,"uuid":"539514474","full_name":"Cassin01/rcz","owner":"Cassin01","description":"A tool to write a commit message","archived":false,"fork":false,"pushed_at":"2023-01-31T04:17:16.000Z","size":3540,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T17:52:42.048Z","etag":null,"topics":["cli","git","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cassin01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-09-21T13:53:23.000Z","updated_at":"2024-07-08T20:04:20.000Z","dependencies_parsed_at":"2023-02-16T07:15:22.836Z","dependency_job_id":null,"html_url":"https://github.com/Cassin01/rcz","commit_stats":{"total_commits":47,"total_committers":2,"mean_commits":23.5,"dds":"0.14893617021276595","last_synced_commit":"fe4e145c012174117fbe710c6a12d8e48a5497d6"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cassin01%2Frcz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cassin01%2Frcz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cassin01%2Frcz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cassin01%2Frcz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cassin01","download_url":"https://codeload.github.com/Cassin01/rcz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248580661,"owners_count":21128031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","git","rust"],"created_at":"2025-04-12T14:29:37.748Z","updated_at":"2025-10-26T17:03:43.207Z","avatar_url":"https://github.com/Cassin01.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rcz\n\nA tool to write a commit message based on [Conventional Commits](https://www.conventionalcommits.org/)  \ninspired by [git-cz](https://github.com/streamich/git-cz)\n\n![GitHub CI](https://github.com/Cassin01/rcz/actions/workflows/rust_ci.yml/badge.svg)\n\n## Installation\n\n```sh\ncargo install rcz\n```\n\n## Example\n\n```zsh\n# bash\nfunction gitz() {\n  local output\n  if output=$(rcz); then\n    git commit -m \"${output}\"\n  else\n    echo \"Err: failed to generate a commit message\"\n  fi\n}\n```\nor\n\n`.gitconfig`\n```.gitconfig\n[alias]\n  cz = \"!gitz() { if local output= ...}; gitz\"\n\n```\n\n\u003cdetails\u003e\n\u003csummary\u003egif\u003c/summary\u003e\n\n![gif](https://github.com/Cassin01/rcz/blob/34789fd4c59983201745cbe3c760252e23320d69/asset/example-gitz.gif)\n\n\u003c/details\u003e\n\n## Configuration\n\nThe configuration file will be automatically generated on:\n\n- Linux: `~/.config/rcz`\n- Windows: `{FOLDERID_RoamingAppData}\\rcz`\n- Mac OS: `~/Library/Preferences/rs.rcz`\n\n\n\u003cdetails\u003e\n\u003csummary\u003eDefault configuration\u003c/summary\u003e\n\n```toml\nformat = '''\n{type}: {subject}'''\n\n[[types]]\ndescription = 'A bug fix'\nvalue = 'fix'\nemoji = '🐛'\n\n[[types]]\ndescription = 'A new feature'\nvalue = 'feat'\nemoji = '✨'\n\n[[types]]\ndescription = 'Changes that introduces a breaking API change'\nvalue = 'BREAKING CHANGE'\nemoji = '💥'\n\n[[types]]\ndescription = 'build system or external dependencies'\nvalue = 'chore'\nemoji = '🛠️'\n\n[[types]]\ndescription = 'CI related changes'\nvalue = 'ci'\nemoji = '💫'\n\n[[types]]\ndescription = 'Documentation only changes'\nvalue = 'docs'\nemoji = '✏️'\n\n[[types]]\ndescription = 'Changes that do not affect the meaning of the code'\nvalue = 'style'\nemoji = '💄'\n\n[[types]]\ndescription = 'A code change that neither fixes a bug nor adds a feature'\nvalue = 'refactor'\nemoji = '🧹'\n\n[[types]]\ndescription = ' A code change that improves performance'\nvalue = 'perf'\nemoji = '🚄'\n\n[[types]]\ndescription = 'Adding or correcting tests'\nvalue = 'test'\nemoji = '🧪'\n```\n\u003c/details\u003e\n\n### Format\n\nAll section etc `{scope}` that you can add on the format are bellow.\n\n- `{type}`\n- `{emoji}`\n- `{description}`\n\n:warning: The string that enclosed in double brackets (`{{echo 'foo'}}`, `{{date}}` etc) is interpreted as shell script.\n\nOther strings (`{body}`, `{footer}`, `{header}` etc) is interpreted as a custom input.  \nThe string is used as a prompt message.\n\nSometimes you don't have a scope and have to delete the brackets. If a space is entered for scope, brackets are removed altogether. [#6](https://github.com/Cassin01/rcz/issues/6)\n\nA example for your customize is bellow.\n\n```toml\nformat = '''\n{type}{scope}: {emoji}{subject}\n{body}\n{footer}'''\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcassin01%2Frcz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcassin01%2Frcz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcassin01%2Frcz/lists"}