Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Zhengqbbb/cz-git

cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI
https://github.com/Zhengqbbb/cz-git

cli commit commit-message commitizen commitizen-adapter commitlint cz-git czg emoji emojis node nodejs openai pnpm vitepress workflow workflows

Last synced: 27 days ago
JSON representation

cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI

Host: GitHub
URL: https://github.com/Zhengqbbb/cz-git
Owner: Zhengqbbb
License: mit
Created: 2022-02-15T07:17:04.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-04-29T20:05:57.000Z (about 2 months ago)
Last Synced: 2024-05-16T22:02:03.773Z (about 1 month ago)
Topics: cli, commit, commit-message, commitizen, commitizen-adapter, commitlint, cz-git, czg, emoji, emojis, node, nodejs, openai, pnpm, vitepress, workflow, workflows
Language: TypeScript
Homepage: https://cz-git.qbb.sh
Size: 15.2 MB
Stars: 971
Watchers: 8
Forks: 33
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-chatgpt - cz-git - Automatically generate Git commit messages. (CLI tools / Examples)
cli-apps - czg - Interactively generate standardized commit messages. (<a name="git"></a>Git and accessories)
awesome-chatgpt-api - cz-git
awesome-chatgpt - cz-git - Automatically generate Git commit messages. (CLI tools / Examples)
awesome-chatgpt-api - cz-git
awesome-stars - Zhengqbbb/cz-git - cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI (workflow)
my-awesome - Zhengqbbb/cz-git - message,commitizen,commitizen-adapter,commitlint,cz-git,czg,emoji,emojis,node,nodejs,openai,pnpm,vitepress,workflow,workflows pushed_at:2024-05 star:1.0k fork:0.0k cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI (TypeScript)
awesome-cli-apps - czg - Interactively generate standardized commit messages. (<a name="git"></a>Git and accessories)
my-awesome-stars - cz-git - git \| czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI | Zhengqbbb | 782 | (TypeScript)
awesome - Zhengqbbb/cz-git - cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI (TypeScript)

README

        


    

        

    



cz-git




    

      

    

    

      

    

    


    

      

    

    

      

    

    

      

    

    


    

        

        

    

    

        

    

    


    

        

    





    GitHub

      |  

    Installation

      |  

    Website

      |  

    CLI

    


    简体中文文档



## Introduction

Support OpenAI, and more engineered, lightweight, customizable, standard output format [Commitizen adapter](https://cz-git.qbb.sh/guide/introduction) and [Git commit CLI](https://cz-git.qbb.sh/cli/).

![demo-gif](https://user-images.githubusercontent.com/40693636/188255006-b9df9837-4678-4085-9395-e2905d7ec7de.gif)

> **What is commitizen**: A Node.js-based `git commit` command-line tool that assists in generating standardized commit messages. 



> **What is an adapter**: Replace the **interactive** plugin for the commitizen command line tool.

## Feature

- 🤖 **OpenAI support.** Let the AI generate your git commit message.

- 💪 Just to be a **lazy man** !!! Friendly command line tool, Supports **search and selection** on the command line, reducing spelling errors.

- ⚡️ **Lightweight**, **Highly Customizable**, but the output format follows the standard [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.

- 🔨 [Better for monorepo engineering](https://cz-git.qbb.sh/recipes/#scopes) and **commitlint** project to give relevant verification information to the command line.

- ✅ Support commit with **emoji** ｜ Better linking with [issuePrefix](https://cz-git.qbb.sh/recipes/default-issues.html) **for issue**

[⇒ Why cz-git](https://cz-git.qbb.sh/guide/why.html)

```bash

$ npm i -D cz-git

+ cz-git          (1.9 MB)

added 1 package in 0.582s

```

[⇒ Why czg](https://cz-git.qbb.sh/cli/why.html)

```bash

$ npm i -g czg

+ czg             (1.5 MB)

added 1 package in 0.531s

```

## Projects using cz-git

  

    

      

        


        _Nx

      

    

    

      

        


        _{Element Plus}

      

    

    

      

        


        _{Ant Design Vue}

      

    

    

      

        


        _{TDesign-Vue-Next}

      

    

  

  

    

      

        


        _Vben-Admin

      

    

    

      

        


        _{Vue3-Antd-Admin}

      

    

    

      

        


        _Geeker-Admin

      

    

    

      

        


        _iDux

      

    

  

  

    

      

        


        _{Vuepress-Theme-Hope}

      

    

    

      

        


        _{Vuepress-Theme-Gungnir}

      

    

  

## Get Started

> 「cz-git & czg」 require Node >=**v12.20**

- `cz-git` + [`Commitizen`](https://github.com/commitizen/cz-cli) [⇒ Get Started](https://cz-git.qbb.sh/guide/)

- `czg` [⇒ Get Started](https://cz-git.qbb.sh/cli/install)

## Configure Template

[⇒ Configure Template](https://cz-git.qbb.sh/config/)

## Options

[⇒ Show Related](https://cz-git.qbb.sh/config/show.html)

[⇒ Engineering Related](https://cz-git.qbb.sh/config/engineer.html)

## Recipes

[⇒ Recipes](https://cz-git.qbb.sh/recipes/)

## FAQ

[⇒ FAQ](https://cz-git.qbb.sh/faq/)

## LICENSE

MIT

Copyright (c) 2022-present Qiubin Zheng  (https://github.com/Zhengqbbb)

> I just do my best to make thing well, Could you give a [star ⭐](https://github.com/Zhengqbbb/cz-git) to encourage me ?



  


  _{https://packagephobia.com/result?p=cz-git,czg}