{"id":45805666,"url":"https://commitizen-tools.github.io/commitizen/","last_synced_at":"2026-03-11T22:01:09.618Z","repository":{"id":38189111,"uuid":"106127589","full_name":"commitizen-tools/commitizen","owner":"commitizen-tools","description":"Create committing rules for projects :rocket: auto bump versions :arrow_up: and auto changelog generation :open_file_folder: ","archived":false,"fork":false,"pushed_at":"2026-03-08T08:15:40.000Z","size":25767,"stargazers_count":3326,"open_issues_count":145,"forks_count":328,"subscribers_count":14,"default_branch":"master","last_synced_at":"2026-03-10T17:31:07.157Z","etag":null,"topics":["bump-version","changelog-generator","commitizen","conventional-commits","git","python","python3","release-automation","semantic-versioning","semver"],"latest_commit_sha":null,"homepage":"https://commitizen-tools.github.io/commitizen/","language":"Python","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/commitizen-tools.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"open_collective":"commitizen-tools","github":"commitizen-tools"}},"created_at":"2017-10-07T20:15:34.000Z","updated_at":"2026-03-10T17:19:12.000Z","dependencies_parsed_at":"2026-03-02T08:02:09.708Z","dependency_job_id":null,"html_url":"https://github.com/commitizen-tools/commitizen","commit_stats":{"total_commits":1644,"total_committers":144,"mean_commits":"11.416666666666666","dds":0.7670316301703163,"last_synced_commit":"fc929208abe0ceda456f7203a61f28ea0afef9ad"},"previous_names":[],"tags_count":316,"template":false,"template_full_name":null,"purl":"pkg:github/commitizen-tools/commitizen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commitizen-tools%2Fcommitizen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commitizen-tools%2Fcommitizen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commitizen-tools%2Fcommitizen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commitizen-tools%2Fcommitizen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commitizen-tools","download_url":"https://codeload.github.com/commitizen-tools/commitizen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commitizen-tools%2Fcommitizen/sbom","scorecard":{"id":300933,"data":{"date":"2025-08-11","repo":{"name":"github.com/commitizen-tools/commitizen","commit":"9e6830c97b498d1ffc7a52b66908d82764668c44"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5,"checks":[{"name":"Code-Review","score":6,"reason":"Found 9/14 approved changesets -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 19 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/label_pr.yml:8","Warn: no topLevel permission defined: .github/workflows/bumpversion.yml:1","Warn: no topLevel permission defined: .github/workflows/docspublish.yml:1","Warn: no topLevel permission defined: .github/workflows/homebrewpublish.yml:1","Warn: no topLevel permission defined: .github/workflows/label_issues.yml:1","Warn: no topLevel permission defined: .github/workflows/label_pr.yml:1","Warn: no topLevel permission defined: .github/workflows/pythonpackage.yml:1","Warn: no topLevel permission defined: .github/workflows/pythonpublish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bumpversion.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/bumpversion.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/bumpversion.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/bumpversion.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/bumpversion.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/bumpversion.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docspublish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/docspublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docspublish.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/docspublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docspublish.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/docspublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docspublish.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/docspublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docspublish.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/docspublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docspublish.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/docspublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/homebrewpublish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/homebrewpublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/homebrewpublish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/homebrewpublish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/homebrewpublish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/homebrewpublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label_issues.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/label_issues.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label_pr.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/label_pr.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label_pr.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/label_pr.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label_pr.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/label_pr.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pythonpackage.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/pythonpackage.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pythonpackage.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/pythonpackage.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pythonpackage.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/pythonpackage.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pythonpublish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/pythonpublish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pythonpublish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/commitizen-tools/commitizen/pythonpublish.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/docspublish.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/docspublish.yml:59","Warn: pipCommand not pinned by hash: .github/workflows/homebrewpublish.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/pythonpackage.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/pythonpublish.yml:22","Info:   0 out of  15 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   6 third-party GitHubAction dependencies pinned","Info:   0 out of   5 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":4,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'master'","Info: 'force pushes' disabled on branch 'master'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'","Warn: 'stale review dismissal' is disabled on branch 'master'","Warn: required approving review count is 1 on branch 'master'","Info: codeowner review is required on branch 'master'","Warn: 'last push approval' is disabled on branch 'master'","Warn: 'up-to-date branches' is disabled on branch 'master'","Info: status check found to merge onto on branch 'master'","Info: PRs are required in order to make changes on branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-48p4-8xcf-vxj5","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T20:36:19.220Z","repository_id":38189111,"created_at":"2025-08-17T20:36:19.220Z","updated_at":"2025-08-17T20:36:19.220Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30404068,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T21:51:19.558Z","status":"ssl_error","status_checked_at":"2026-03-11T21:50:57.892Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["bump-version","changelog-generator","commitizen","conventional-commits","git","python","python3","release-automation","semantic-versioning","semver"],"created_at":"2026-02-26T14:00:19.342Z","updated_at":"2026-03-11T22:01:09.612Z","avatar_url":"https://github.com/commitizen-tools.png","language":"Python","readme":"[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/commitizen-tools/commitizen/pythonpackage.yml?label=python%20package\u0026logo=github\u0026logoColor=white\u0026style=flat-square)](https://github.com/commitizen-tools/commitizen/actions)\n[![Check Links](https://github.com/commitizen-tools/commitizen/actions/workflows/links.yml/badge.svg)](https://github.com/commitizen-tools/commitizen/actions/workflows/links.yml)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)\n[![PyPI Package latest release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)\n[![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/commitizen?style=flat-square)](https://pypi.org/project/commitizen/)\n[![Supported versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/commitizen?style=flat-square)](https://anaconda.org/conda-forge/commitizen)\n[![homebrew](https://img.shields.io/homebrew/v/commitizen?color=teal\u0026style=flat-square)](https://formulae.brew.sh/formula/commitizen)\n[![Codecov](https://img.shields.io/codecov/c/github/commitizen-tools/commitizen.svg?style=flat-square)](https://codecov.io/gh/commitizen-tools/commitizen)\n[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json\u0026style=flat-square\u0026color=brightgreen)](https://github.com/j178/prek)\n\n![Using Commitizen cli](images/cli_interactive/commit.gif)\n\n---\n\n[**Commitizen Documentation Site**](https://commitizen-tools.github.io/commitizen/)\n\n---\n\n## About\n\nCommitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management.\n\n### What Commitizen Does\n\nBy enforcing standardized commit conventions (defaulting to [Conventional Commits][conventional_commits]), Commitizen helps teams:\n\n- Write clear, structured commit messages\n- Automatically manage version numbers using semantic versioning\n- Generate and maintain changelogs\n- Streamline the release process\n\n### Key Benefits\n\nWith just a simple `cz bump` command, Commitizen handles:\n\n1. **Version Management**: Automatically bumps version numbers and updates version files based on your commit history\n2. **Changelog Generation**: Creates and updates changelogs following the [Keep a changelog][keepchangelog] format\n3. **Commit Standardization**: Enforces consistent commit message formats across your team\n\nThis standardization makes your commit history more readable and meaningful, while the automation reduces manual work and potential errors in the release process.\n\n### Features\n\n- Interactive CLI for standardized commits with default [Conventional Commits][conventional_commits] support\n- Intelligent [version bumping](https://commitizen-tools.github.io/commitizen/commands/bump/) using [Semantic Versioning][semver]\n- Automatic [keep a changelog][keepchangelog] generation\n- Built-in commit validation with pre-commit hooks\n- [Customizable](https://commitizen-tools.github.io/commitizen/customization/config_file/) commit rules and templates\n- Multi-format version file support\n- Custom rules and plugins via pip\n\n## Getting Started\n\n### Requirements\n\nBefore installing Commitizen, ensure you have:\n\n- [Python](https://www.python.org/downloads/) `3.10+`\n- [Git][gitscm] `1.8.5.2+`\n\n### Installation\n\n#### Global Installation (Recommended)\n\nThe recommended way to install Commitizen is using [`pipx`](https://pipx.pypa.io/) or [`uv`](https://docs.astral.sh/uv/), which ensures a clean, isolated installation:\n\n**Using pipx:**\n```bash\n# Install Commitizen\npipx install commitizen\n\n# Keep it updated\npipx upgrade commitizen\n```\n\n**Using uv:**\n```bash\n# Install commitizen\nuv tool install commitizen\n\n# Keep it updated\nuv tool upgrade commitizen\n```\n\n**(For macOS users) Using Homebrew:**\n```bash\nbrew install commitizen\n```\n\n#### Project-Specific Installation\n\nYou can add Commitizen to your Python project using any of these package managers:\n\n**Using pip:**\n```bash\npip install -U commitizen\n```\n\n**Using conda:**\n```bash\nconda install -c conda-forge commitizen\n```\n\n**Using Poetry:**\n```bash\n# For Poetry \u003e= 1.2.0\npoetry add commitizen --group dev\n\n# For Poetry \u003c 1.2.0\npoetry add commitizen --dev\n```\n\n**Using uv:**\n```bash\nuv add --dev commitizen\n```\n\n**Using pdm:**\n```bash\npdm add -d commitizen\n```\n\n### Basic Commands\n\n#### Initialize Commitizen\n\nTo get started, run the `cz init` command. This will guide you through the process of creating a configuration file with your preferred settings.\n\n#### Create Commits\n\nCreate standardized commits using:\n```sh\ncz commit\n# or use the shortcut\ncz c\n```\n\nTo sign off your commits:\n```sh\ncz commit -- --signoff\n# or use the shortcut\ncz commit -- -s\n```\n\nFor more commit options, run `cz commit --help`.\n\n#### Version Management\n\nThe most common command you'll use is:\n```sh\ncz bump\n```\n\nThis command:\n\n- Bumps your project's version\n- Creates a git tag\n- Updates the changelog (if `update_changelog_on_bump` is enabled)\n- Updates version files\n\nYou can customize:\n\n- [Version files](https://commitizen-tools.github.io/commitizen/commands/bump/#version_files)\n- [Version scheme](https://commitizen-tools.github.io/commitizen/commands/bump/#version_scheme)\n- [Version provider](https://commitizen-tools.github.io/commitizen/config/version_provider/)\n\nFor all available options, see the [bump command documentation](https://commitizen-tools.github.io/commitizen/commands/bump/).\n\n### Advanced Usage\n\n#### Get Project Version\n\n```sh\n# Get your project's version (instead of Commitizen's version)\ncz version -p\n# Preview changelog changes\ncz changelog --dry-run \"$(cz version -p)\"\n```\n\nThis command is particularly useful for automation scripts and CI/CD pipelines.\n\nFor example, you can use the output of the command `cz changelog --dry-run \"$(cz version -p)\"` to notify your team about a new release in Slack.\n\n#### Prek and Pre-commit Integration\n\nCommitizen can automatically validate your commit messages using pre-commit hooks.\n\n1. Add to your `.pre-commit-config.yaml`:\n```yaml\n---\nrepos:\n  - repo: https://github.com/commitizen-tools/commitizen\n    rev: master  # Replace with latest tag\n    hooks:\n      - id: commitizen\n      - id: commitizen-branch\n        stages: [pre-push]\n```\n\n2. Install the hooks:\n```sh\nprek install --hook-type commit-msg --hook-type pre-push\n```\n\n| Hook              | Recommended Stage |\n| ----------------- | ----------------- |\n| commitizen        | commit-msg        |\n| commitizen-branch | pre-push          |\n\n\u003e **Note**: Replace `master` with the [latest tag](https://github.com/commitizen-tools/commitizen/tags) to avoid warnings. You can automatically update this with:\n\u003e ```sh\n\u003e prek autoupdate\n\u003e ```\n\nFor more details about commit validation, see the [check command documentation](https://commitizen-tools.github.io/commitizen/commands/check/).\n\n## Help \u0026 Reference\n\n### Command Line Interface\n\nCommitizen provides a comprehensive CLI with various commands. Here's the complete reference:\n\n![cz --help](images/cli_help/cz___help.svg)\n\n### Quick Reference\n\n| Command | Description | Alias |\n|---------|-------------|-------|\n| `cz init` | Initialize Commitizen configuration | - |\n| `cz commit` | Create a new commit | `cz c` |\n| `cz bump` | Bump version and update changelog | - |\n| `cz changelog` | Generate changelog | `cz ch` |\n| `cz check` | Validate commit messages | - |\n| `cz version` | Show version information | - |\n\n### Additional Resources\n\n- [Conventional Commits Specification][conventional_commits]\n- [Exit Codes Reference](https://commitizen-tools.github.io/commitizen/exit_codes/)\n- [Configuration Guide](https://commitizen-tools.github.io/commitizen/config/configuration_file/)\n- [Command Documentation](https://commitizen-tools.github.io/commitizen/commands/init/)\n\n### Getting Help\n\nFor each command, you can get detailed help by adding `--help`:\n\n```sh\ncz commit --help\ncz bump --help\ncz changelog --help\n```\n\nFor more details, visit our [documentation site](https://commitizen-tools.github.io/commitizen/).\n\n## Setting up bash completion\n\nCommitizen supports command-line completion through [argcomplete](https://kislyuk.github.io/argcomplete/), which is automatically installed as a dependency. This feature provides intelligent auto-completion for all Commitizen commands and options.\n\n### Supported Shells\n\n- **Bash**: Full support\n- **Zsh**: Limited support\n- **Fish**: Limited support\n- **Tcsh**: Limited support\n\n### Installation Methods\n\n#### Global Installation (Recommended)\n\nIf you installed Commitizen globally (e.g., using `pipx` or `brew`), you can enable global completion:\n\n```bash\n# Enable global completion for all Python applications\nsudo activate-global-python-argcomplete\n```\n\n#### User-Specific Installation\n\nFor a user-specific installation that persists across sessions:\n\n```bash\n# Add to your shell's startup file (e.g., ~/.bashrc, ~/.zshrc)\nregister-python-argcomplete cz \u003e\u003e ~/.bashrc\n```\n\n#### Temporary Installation\n\nFor one-time activation in your current shell session:\n\n```bash\n# Activate completion for current session only\neval \"$(register-python-argcomplete cz)\"\n```\n\n### Verification\n\nAfter installation, you can verify the completion is working by:\n\n1. Opening a new terminal session\n2. Typing `cz` followed by a space and pressing `TAB` twice\n3. You should see a list of available commands\n\nFor more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/).\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=commitizen-tools/commitizen)](https://star-history.com/#commitizen-tools/commitizen)\n\n\n## Sponsors\n\nThese are our cool sponsors!\n\n\u003c!-- sponsors --\u003e\u003c!-- sponsors --\u003e\n\n[conventional_commits]: https://www.conventionalcommits.org\n[semver]: https://semver.org/\n[keepchangelog]: https://keepachangelog.com/\n[gitscm]: https://git-scm.com/downloads\n","funding_links":["https://opencollective.com/commitizen-tools","https://github.com/sponsors/commitizen-tools"],"categories":["Git \u0026 Version Control"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/commitizen-tools.github.io%2Fcommitizen%2F","html_url":"https://awesome.ecosyste.ms/projects/commitizen-tools.github.io%2Fcommitizen%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/commitizen-tools.github.io%2Fcommitizen%2F/lists"}