index.html


<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
        <meta name="description" content="commit rules, semantic version, conventional commits">
      
      
        <link rel="next" href="getting_started/">
      
      
      <link rel="icon" href="assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.36">
    
    
        <title>Commitizen</title>
      
    
      <link rel="stylesheet" href="assets/stylesheets/main.06209087.min.css">
      
        
        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
      
      
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      
  </head>
  
  
    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="indigo">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#about" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
    
<header class="md-header md-header--shadow" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="." title="Commitizen" class="md-header__button md-logo" aria-label="Commitizen" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            Commitizen
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              Introduction
            
          </span>
        </div>
      </div>
    </div>
    
      
        <form class="md-header__option" data-md-component="palette">
  
    
    <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="indigo"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
    
  
    <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_1">
    
      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_2" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg>
      </label>
    
  
    <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_2">
    
      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_3" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
      </label>
    
  
    <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to system preference"  type="radio" name="__palette" id="__palette_3">
    
      <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
      </label>
    
  
</form>
      
    
      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
    
    
      <label class="md-header__button md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
      <div class="md-header__source">
        <a href="https://github.com/commitizen-tools/commitizen" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  </div>
  <div class="md-source__repository">
    commitizen-tools/commitizen
  </div>
</a>
      </div>
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="." title="Commitizen" class="md-nav__button md-logo" aria-label="Commitizen" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>

    </a>
    Commitizen
  </label>
  
    <div class="md-nav__source">
      <a href="https://github.com/commitizen-tools/commitizen" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  </div>
  <div class="md-source__repository">
    commitizen-tools/commitizen
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    Introduction
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="." class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    Introduction
  </span>
  

      </a>
      
        
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#about" class="md-nav__link">
    <span class="md-ellipsis">
      About
    </span>
  </a>
  
    <nav class="md-nav" aria-label="About">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#features" class="md-nav__link">
    <span class="md-ellipsis">
      Features
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#requirements" class="md-nav__link">
    <span class="md-ellipsis">
      Requirements
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#installation" class="md-nav__link">
    <span class="md-ellipsis">
      Installation
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Installation">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#python-project" class="md-nav__link">
    <span class="md-ellipsis">
      Python project
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#macos" class="md-nav__link">
    <span class="md-ellipsis">
      macOS
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#usage" class="md-nav__link">
    <span class="md-ellipsis">
      Usage
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Usage">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#help" class="md-nav__link">
    <span class="md-ellipsis">
      Help
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#setting-up-bash-completion" class="md-nav__link">
    <span class="md-ellipsis">
      Setting up bash completion
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#sponsors" class="md-nav__link">
    <span class="md-ellipsis">
      Sponsors
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    <li class="md-nav__item">
      <a href="getting_started/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Getting Started
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
        
          
          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Commands
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_3">
            <span class="md-nav__icon md-icon"></span>
            Commands
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="commands/init/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    init
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/commit/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    commit
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/bump/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    bump
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/check/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    check
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/changelog/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    changelog
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/example/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    example
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/info/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    info
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/ls/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ls
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/schema/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    schema
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="commands/version/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    version
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item">
      <a href="config/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Configuration
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="customization/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Customization
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
        
          
          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Tutorials
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_6">
            <span class="md-nav__icon md-icon"></span>
            Tutorials
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="tutorials/writing_commits/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Writing commits
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="tutorials/auto_check/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Auto check commits
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="tutorials/auto_prepare_commit_message/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Auto prepare commit message
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="tutorials/gitlab_ci/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    GitLab CI
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="tutorials/github_actions/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Github Actions
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="tutorials/jenkins_pipeline/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Jenkins pipeline
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="tutorials/dev_releases/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Developmental releases
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item">
      <a href="faq/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    FAQ
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="exit_codes/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Exit Codes
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="third-party-commitizen/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Third-Party Commitizen Templates
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="contributing/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Contributing
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="external_links/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Resources
  </span>
  

      </a>
    </li>
  

  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#about" class="md-nav__link">
    <span class="md-ellipsis">
      About
    </span>
  </a>
  
    <nav class="md-nav" aria-label="About">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#features" class="md-nav__link">
    <span class="md-ellipsis">
      Features
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#requirements" class="md-nav__link">
    <span class="md-ellipsis">
      Requirements
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#installation" class="md-nav__link">
    <span class="md-ellipsis">
      Installation
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Installation">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#python-project" class="md-nav__link">
    <span class="md-ellipsis">
      Python project
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#macos" class="md-nav__link">
    <span class="md-ellipsis">
      macOS
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#usage" class="md-nav__link">
    <span class="md-ellipsis">
      Usage
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Usage">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#help" class="md-nav__link">
    <span class="md-ellipsis">
      Help
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#setting-up-bash-completion" class="md-nav__link">
    <span class="md-ellipsis">
      Setting up bash completion
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#sponsors" class="md-nav__link">
    <span class="md-ellipsis">
      Sponsors
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  
  <h1>Introduction</h1>

<p><a href="https://github.com/commitizen-tools/commitizen/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/commitizen-tools/commitizen/pythonpackage.yml?label=python%20package&amp;logo=github&amp;logoColor=white&amp;style=flat-square" /></a>
<a href="https://conventionalcommits.org"><img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square" /></a>
<a href="https://pypi.org/project/commitizen/"><img alt="PyPI Package latest release" src="https://img.shields.io/pypi/v/commitizen.svg?style=flat-square" /></a>
<a href="https://pypi.org/project/commitizen/"><img alt="PyPI Package download count (per month)" src="https://img.shields.io/pypi/dm/commitizen?style=flat-square" /></a>
<a href="https://pypi.org/project/commitizen/"><img alt="Supported versions" src="https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square" /></a>
<a href="https://formulae.brew.sh/formula/commitizen"><img alt="homebrew" src="https://img.shields.io/homebrew/v/commitizen?color=teal&amp;style=flat-square" /></a>
<a href="https://codecov.io/gh/commitizen-tools/commitizen"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/commitizen-tools/commitizen.svg?style=flat-square" /></a>
<a href="https://github.com/pre-commit/pre-commit"><img alt="pre-commit" src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&amp;logo=pre-commit&amp;logoColor=white" /></a></p>
<p><img alt="Using commitizen cli" src="images/demo.gif" /></p>
<hr />
<p><strong>Documentation:</strong> <a href="https://commitizen-tools.github.io/commitizen/">https://commitizen-tools.github.io/commitizen/</a></p>
<hr />
<h2 id="about">About<a class="headerlink" href="#about" title="Permanent link">&para;</a></h2>
<p>Commitizen is release management tool designed for teams.</p>
<p>Commitizen assumes your team uses a standard way of committing rules
and from that foundation, it can bump your project's version, create
the changelog, and update files.</p>
<p>By default, commitizen uses <a href="https://www.conventionalcommits.org">conventional commits</a>, but you
can build your own set of rules, and publish them.</p>
<p>Using a standardized set of rules to write commits, makes commits easier to read, and enforces writing
descriptive commits.</p>
<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">&para;</a></h3>
<ul>
<li>Command-line utility to create commits with your rules. Defaults: <a href="https://www.conventionalcommits.org">Conventional commits</a></li>
<li>Bump version automatically using <a href="https://semver.org/">semantic versioning</a> based on the commits. <a href="commands/bump/">Read More</a></li>
<li>Generate a changelog using <a href="https://keepachangelog.com/">Keep a changelog</a></li>
<li>Update your project's version files automatically</li>
<li>Display information about your commit rules (commands: schema, example, info)</li>
<li>Create your own set of rules and publish them to pip. Read more on <a href="customization/">Customization</a></li>
</ul>
<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">&para;</a></h2>
<p><a href="https://www.python.org/downloads/">Python</a> <code>3.8+</code></p>
<p><a href="https://git-scm.com/downloads">Git</a> <code>1.8.5.2+</code></p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>
<p>Install commitizen in your system using <code>pipx</code> (Recommended, <a href="https://pypa.github.io/pipx/installation/">https://pypa.github.io/pipx/installation/</a>):</p>
<div class="highlight"><pre><span></span><code>pipx<span class="w"> </span>ensurepath
pipx<span class="w"> </span>install<span class="w"> </span>commitizen
pipx<span class="w"> </span>upgrade<span class="w"> </span>commitizen
</code></pre></div>
<p>Install commitizen using <code>pip</code> with <code>--user</code> flag:</p>
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>--user<span class="w"> </span>-U<span class="w"> </span>commitizen
</code></pre></div>
<h3 id="python-project">Python project<a class="headerlink" href="#python-project" title="Permanent link">&para;</a></h3>
<p>You can add it to your local project using one of these:</p>
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>commitizen
</code></pre></div>
<p>for Poetry &gt;= 1.2.0:</p>
<div class="highlight"><pre><span></span><code>poetry<span class="w"> </span>add<span class="w"> </span>commitizen<span class="w"> </span>--group<span class="w"> </span>dev
</code></pre></div>
<p>for Poetry &lt; 1.2.0:</p>
<div class="highlight"><pre><span></span><code>poetry<span class="w"> </span>add<span class="w"> </span>commitizen<span class="w"> </span>--dev
</code></pre></div>
<h3 id="macos">macOS<a class="headerlink" href="#macos" title="Permanent link">&para;</a></h3>
<p>via <a href="https://formulae.brew.sh/formula/commitizen">homebrew</a>:</p>
<div class="highlight"><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>commitizen
</code></pre></div>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
<p>Most of the time this is the only command you'll run:</p>
<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>bump
</code></pre></div>
<p>On top of that, you can use commitizen to assist you with the creation of commits:</p>
<div class="highlight"><pre><span></span><code>cz<span class="w"> </span>commit
</code></pre></div>
<p>Read more in the section <a href="getting_started/">Getting Started</a>.</p>
<h3 id="help">Help<a class="headerlink" href="#help" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>cz<span class="w"> </span>--help
usage:<span class="w"> </span>cz<span class="w"> </span><span class="o">[</span>-h<span class="o">]</span><span class="w"> </span><span class="o">[</span>--debug<span class="o">]</span><span class="w"> </span><span class="o">[</span>-n<span class="w"> </span>NAME<span class="o">]</span><span class="w"> </span><span class="o">[</span>-nr<span class="w"> </span>NO_RAISE<span class="o">]</span><span class="w"> </span><span class="o">{</span>init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version<span class="o">}</span><span class="w"> </span>...

Commitizen<span class="w"> </span>is<span class="w"> </span>a<span class="w"> </span>cli<span class="w"> </span>tool<span class="w"> </span>to<span class="w"> </span>generate<span class="w"> </span>conventional<span class="w"> </span>commits.
For<span class="w"> </span>more<span class="w"> </span>information<span class="w"> </span>about<span class="w"> </span>the<span class="w"> </span>topic<span class="w"> </span>go<span class="w"> </span>to<span class="w"> </span>https://conventionalcommits.org/

optional<span class="w"> </span>arguments:
<span class="w">  </span>-h,<span class="w"> </span>--help<span class="w">            </span>show<span class="w"> </span>this<span class="w"> </span><span class="nb">help</span><span class="w"> </span>message<span class="w"> </span>and<span class="w"> </span><span class="nb">exit</span>
<span class="w">  </span>--config<span class="w">              </span>the<span class="w"> </span>path<span class="w"> </span>of<span class="w"> </span>configuration<span class="w"> </span>file
<span class="w">  </span>--debug<span class="w">               </span>use<span class="w"> </span>debug<span class="w"> </span>mode
<span class="w">  </span>-n<span class="w"> </span>NAME,<span class="w"> </span>--name<span class="w"> </span>NAME<span class="w">  </span>use<span class="w"> </span>the<span class="w"> </span>given<span class="w"> </span>commitizen<span class="w"> </span><span class="o">(</span>default:<span class="w"> </span>cz_conventional_commits<span class="o">)</span>
<span class="w">  </span>-nr<span class="w"> </span>NO_RAISE,<span class="w"> </span>--no-raise<span class="w"> </span>NO_RAISE
<span class="w">                        </span>comma<span class="w"> </span>separated<span class="w"> </span>error<span class="w"> </span>codes<span class="w"> </span>that<span class="w"> </span>won<span class="err">&#39;</span>t<span class="w"> </span>rise<span class="w"> </span>error,<span class="w"> </span>e.g:<span class="w"> </span>cz<span class="w"> </span>-nr<span class="w"> </span><span class="m">1</span>,2,3<span class="w"> </span>bump.<span class="w"> </span>See<span class="w"> </span>codes<span class="w"> </span>at<span class="w"> </span>https://commitizen-
<span class="w">                        </span>tools.github.io/commitizen/exit_codes/

commands:
<span class="w">  </span><span class="o">{</span>init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version<span class="o">}</span>
<span class="w">    </span>init<span class="w">                </span>init<span class="w"> </span>commitizen<span class="w"> </span>configuration
<span class="w">    </span>commit<span class="w"> </span><span class="o">(</span>c<span class="o">)</span><span class="w">          </span>create<span class="w"> </span>new<span class="w"> </span>commit
<span class="w">    </span>ls<span class="w">                  </span>show<span class="w"> </span>available<span class="w"> </span>commitizens
<span class="w">    </span>example<span class="w">             </span>show<span class="w"> </span>commit<span class="w"> </span>example
<span class="w">    </span>info<span class="w">                </span>show<span class="w"> </span>information<span class="w"> </span>about<span class="w"> </span>the<span class="w"> </span>cz
<span class="w">    </span>schema<span class="w">              </span>show<span class="w"> </span>commit<span class="w"> </span>schema
<span class="w">    </span>bump<span class="w">                </span>bump<span class="w"> </span>semantic<span class="w"> </span>version<span class="w"> </span>based<span class="w"> </span>on<span class="w"> </span>the<span class="w"> </span>git<span class="w"> </span>log
<span class="w">    </span>changelog<span class="w"> </span><span class="o">(</span>ch<span class="o">)</span><span class="w">      </span>generate<span class="w"> </span>changelog<span class="w"> </span><span class="o">(</span>note<span class="w"> </span>that<span class="w"> </span>it<span class="w"> </span>will<span class="w"> </span>overwrite<span class="w"> </span>existing<span class="w"> </span>file<span class="o">)</span>
<span class="w">    </span>check<span class="w">               </span>validates<span class="w"> </span>that<span class="w"> </span>a<span class="w"> </span>commit<span class="w"> </span>message<span class="w"> </span>matches<span class="w"> </span>the<span class="w"> </span>commitizen<span class="w"> </span>schema
<span class="w">    </span>version<span class="w">             </span>get<span class="w"> </span>the<span class="w"> </span>version<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>installed<span class="w"> </span>commitizen<span class="w"> </span>or<span class="w"> </span>the<span class="w"> </span>current<span class="w"> </span>project<span class="w"> </span><span class="o">(</span>default:<span class="w"> </span>installed<span class="w"> </span>commitizen<span class="o">)</span>
</code></pre></div>
<h2 id="setting-up-bash-completion">Setting up bash completion<a class="headerlink" href="#setting-up-bash-completion" title="Permanent link">&para;</a></h2>
<p>When using bash as your shell (limited support for zsh, fish, and tcsh is available), Commitizen can use <a href="https://kislyuk.github.io/argcomplete/">argcomplete</a> for auto-completion. For this argcomplete needs to be enabled.</p>
<p>argcomplete is installed when you install Commitizen since it's a dependency.</p>
<p>If Commitizen is installed globally, global activation can be executed:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>activate-global-python-argcomplete
</code></pre></div>
<p>For permanent (but not global) Commitizen activation, use:</p>
<div class="highlight"><pre><span></span><code>register-python-argcomplete<span class="w"> </span>cz<span class="w"> </span>&gt;&gt;<span class="w"> </span>~/.bashrc
</code></pre></div>
<p>For one-time activation of argcomplete for Commitizen only, use:</p>
<div class="highlight"><pre><span></span><code><span class="nb">eval</span><span class="w"> </span><span class="s2">&quot;</span><span class="k">$(</span>register-python-argcomplete<span class="w"> </span>cz<span class="k">)</span><span class="s2">&quot;</span>
</code></pre></div>
<p>For further information on activation, please visit the <a href="https://kislyuk.github.io/argcomplete/">argcomplete website</a>.</p>
<h2 id="sponsors">Sponsors<a class="headerlink" href="#sponsors" title="Permanent link">&para;</a></h2>
<p>These are our cool sponsors!</p>
<!-- sponsors -->
<!-- sponsors -->


              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
    <script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
    
    
      <script src="assets/javascripts/bundle.56dfad97.min.js"></script>
      
    
  </body>
</html>