https://github.com/jorgerosbel/gitzen
🧠AI-powered CLI tool for automatic git commit message generation
https://github.com/jorgerosbel/gitzen
agentic-ai ai ai-powered auto-commit cli commit git git-tool
Last synced: 15 days ago
JSON representation
🧠AI-powered CLI tool for automatic git commit message generation
- Host: GitHub
- URL: https://github.com/jorgerosbel/gitzen
- Owner: JorgeRosbel
- License: other
- Created: 2025-07-20T21:59:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-25T22:02:55.000Z (10 months ago)
- Last Synced: 2025-09-14T13:23:58.533Z (9 months ago)
- Topics: agentic-ai, ai, ai-powered, auto-commit, cli, commit, git, git-tool
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/gitzen
- Size: 767 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/gitzen)
[](https://www.npmjs.com/package/gitzen)
[](https://github.com/JorgeRosbel/gitzen/actions)
[](LICENSE)
# Gitzen: AI-powered CLI Tool for Automatic Git Commit Message Generation
**Gitzen** is a command-line tool that uses AI to automatically generate concise and well-formatted git commit messages. It integrates with popular AI providers like Google Gemini and supports customizable templates and languages.
---
## 📚 Table of Contents
* [📦 Installation](#-installation)
* [🛠️ Commands](#-gitzen-command-summary)
* [🚀 Start](./docs/start.md)
* [💾 Commit](./docs/commit.md)
* [🧠 Summarize](./docs/summarize.md)
* [📂 Batch](./docs/batch.md)
* [🔍 Review](./docs/review.md)
* [Gitzen Command Usage & Best Practices](./docs/examples.md)
---
## 📦 Installation
You can install Gitzen globally using your preferred package manager:
```bash
npm install -g gitzen
# or
pnpm add -g gitzen
# or
yarn global add gitzen
```
Once installed globally, the `gitzen` command will be available anywhere in your system.
## 🧾 Gitzen Command Summary
| Command | Description | Notes | Requires Staging |
| ------------------ | ------------------------------------------------------ | ------------------------------------------------------------------ | ---------------- |
| `gitzen start` | 🚀 Initialize Gitzen setup and config | Run once to configure the CLI | ❌ |
| `gitzen commit` | 💾 Generate commit message with AI from staged changes | Requires staged files. Optional: `-y` to auto-accept, `-e` to edit | ✅ |
| `gitzen summarize` | 🧠 Summarize changes in staging/working dir | Optional: `-l ` | ❌ |
| `gitzen batch` | 📂 Group unstaged changes and commit in logical order | Optional: `-i` to ignore `gitzen.config.json` | ❌ |
| `gitzen review` | 🔍 Gives you a review of the code in the staging area | Requires staged files. Optional: `-l ` | ✅ |
Love **Gitzen**? Support the project by buying me a coffee! ☕️
[](https://ko-fi.com/jorgerosbel)
## 📁 Project Structure
The following is the folder and file structure of the project:
```txt
gitzen/
├── __tests__/
│ ├── commitFlow.test.ts
│ └── summarizerFlow.test.ts
│
├── .github/
│ └── workflows/
│ ├── lint_format.yaml
│ ├── publish.yaml
│ └── test.yaml
│
├── .husky/
├── dist/
├── docs/
├── node_modules/
│
├── src/
│ ├── commands/
│ ├── providers/
│ ├── templates/
│ ├── utils/
│ └── index.ts
│
├── types.d.ts
├── .gitignore
├── .npmignore
├── .npmrc
├── .prettierignore
├── .eslintrc.json
├── gitzen.config.json
├── LICENSE
├── package.json
├── package-lock.json
├── prettier.config.mjs
├── README.md
├── tsconfig.json
├── tsup.config.ts
└── vitest.config.ts
```