{"id":15693559,"url":"https://github.com/andostronaut/commitizen-cli","last_synced_at":"2025-05-08T04:21:43.599Z","repository":{"id":170905535,"uuid":"647179765","full_name":"andostronaut/commitizen-cli","owner":"andostronaut","description":"Command-line interface tool that helps enforce standardized commit message formats in Git repositories. ","archived":false,"fork":false,"pushed_at":"2023-10-09T06:39:01.000Z","size":12459,"stargazers_count":8,"open_issues_count":12,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-03T13:43:08.055Z","etag":null,"topics":["cli","command-line","command-line-tool","git","git-commit","process","simple","standard"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/commitizen-cli","language":"TypeScript","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/andostronaut.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-30T08:23:11.000Z","updated_at":"2024-12-01T19:05:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"ce07edd5-8340-400b-8398-c4934ed391db","html_url":"https://github.com/andostronaut/commitizen-cli","commit_stats":null,"previous_names":["iamando/commitizen-cli","andostronaut/commitizen-cli"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andostronaut%2Fcommitizen-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andostronaut%2Fcommitizen-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andostronaut%2Fcommitizen-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andostronaut%2Fcommitizen-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andostronaut","download_url":"https://codeload.github.com/andostronaut/commitizen-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252997545,"owners_count":21837836,"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","command-line","command-line-tool","git","git-commit","process","simple","standard"],"created_at":"2024-10-03T18:45:33.789Z","updated_at":"2025-05-08T04:21:43.569Z","avatar_url":"https://github.com/andostronaut.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg \n    src=\"./logo-banner.png\"\n    alt=\"Commitizen CLI\"\n    style=\"width:100%;\"\n  /\u003e\n\u003c/p\u003e\n\n![build](https://github.com/iamando/commitizen-cli/workflows/build/badge.svg)\n![license](https://img.shields.io/github/license/iamando/commitizen-cli?color=success)\n![npm](https://img.shields.io/npm/v/commitizen-cli)\n\n![Demo](./demo.gif)\n\nCommand-line interface tool that helps enforce standardized commit message formats in Git repositories.\n\n## Features\n\n- **Standardized Commit Messages**: Enforce consistent commit message structure by guiding users through prompts and validating against specified formats.\n- **Conventional Commit Support**: Easily generate commit messages following popular commit conventions like Conventional Commits.\n- **User-Friendly Interface**: Interactive prompt-based interface for creating compliant commit messages without worrying about format details.\n- **Integration with Git**: Seamlessly commit changes directly from the CLI, ensuring compliance with the chosen commit message convention.\n- **Emoji Support**: Add emojis to your commit messages to express the nature of the changes or provide additional context.\n- **Ticket Support**: Set ticket reference to your commit messages to link directly the changes with your task.\n- **Specific Pattern**: Commit pattern is flexible and customisable to provide a better commit message convention.\n- **Configuration Support**: Get or Set specific configuration like pattern config.\n\n## Installation\n\nTo install commitizen-cli, use:\n\n```shell\nnpm install -g commitizen-cli\n```\n\nor if you don't like to install it globaly, use:\n\n```shell\nnpx commitizen-cli\n```\n\n## Usage\n\nNavigate to your Git repository.\n\nRun the following command:\n\n```shell\ncommitizen-cli\n```\n\n## Updating from a Previous Version\n\nIf you have previously installed a version that is older than 3.0.0, it's important to follow these steps to ensure a smooth update process. The new version introduces significant changes that might conflict with remnants of the old installation.\n\nIt's recommended to use the clean command to remove any residual configurations that might still be present. Run the following command:\n\n```shell\ncommitizen-cli clean\n```\n\n## Commands\n\n### Update Command\n\nThe update command allows you to synchronize your local package with the latest changes from the package's repository. To update your package, run:\n\n```shell\ncommitizen-cli update\n```\n\nThis command will fetch the latest updates and apply them to your local package installation. Staying up to date ensures that you have access to new features, bug fixes, and enhancements provided by the package maintainers.\n\n### Config Command\n\nThe config command is used to configure various settings for your package. It supports both get and set modes.\n\nGet Mode\n\nTo retrieve configuration values, use the get mode:\n\n```shell\ncommitizen-cli config get \u003ckey\u003e\n```\n\nThis command will display the current value associated with the specified configuration key.\n\nSet Mode\n\nTo update configuration values, use the set mode:\n\n```shell\ncommitizen-cli config set \u003ckey\u003e=\u003cvalue\u003e\n```\n\n### Clean Command\n\nThe clean command allows you to reset the configuration settings. This command will clear all configurations inside the configuration file generated by the package. To reset the configuration, execute:\n\n```shell\ncommitizen-cli clean\n```\n\nPlease be cautious when using this command, as it will reset all configuration settings. This action is irreversible.\n\n## Configuration\n\nList of type available:\n\n- feature ✨\n- bugfix 🐛\n- hotfix 🚑\n- chore 🛠️\n- epic 📌\n- design 🎨\n- experiment 🧪\n- documentation 📝\n\nPattern is defined like this: `\u003ctype\u003e`(`\u003cticket\u003e`): `\u003ccommit\u003e`\n\n- `\u003ctype\u003e`: Type of commit (feature, bugfix, documentation, ...)\n- `\u003cticket\u003e`: Reference of ticket (if ticket is defined)\n- `\u003ccommit\u003e`: Commit message\n\nExample: design(XXX-000): implement responsive design\n\nBut `\u003cticket\u003e` is an optional pattern, you can set it to false on prompt and the default pattern is like this: `\u003ctype\u003e`: `\u003ccommit\u003e`\n\nExample: feature: implement new chat system on the frontend\n\nAnd `\u003cemoji\u003e` is an optional pattern too, if you like to make your commit cool you can check the use emoji prompt and define custom pattern with `\u003cemoji\u003e`,\nlike this:\n\n- if you have `\u003cticket\u003e` reference: `\u003cemoji\u003e` `\u003ctype\u003e`(`\u003cticket\u003e`): `\u003ccommit\u003e`: 📝 documention(XXX-000): creating new docs on the package\n- or not: `\u003cemoji\u003e` `\u003ctype\u003e`: `\u003ccommit\u003e`: 📝 documention: creating new docs on the package\n\nGet or Set configuration directly to save specific config, use:\n\n```shell\ncommitizen-cli config get PATTERN\n```\n\n```shell\ncommitizen-cli config set PATTERN='specific pattern'\n```\n\n### Update\n\nTo update to the latest version, use:\n\n```shell\ncommitizen-cli update\n```\n\nFollow the prompts to generate a standardized commit message.\n\nThe CLI will execute the Git command to commit your changes with the generated message.\n\n## Support\n\nCommitizen CLI is an MIT-licensed open source project. It can grow thanks to the sponsors and support.\n\n## License\n\nCommitizen CLI is [MIT licensed](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandostronaut%2Fcommitizen-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandostronaut%2Fcommitizen-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandostronaut%2Fcommitizen-cli/lists"}