A lightweight, Go-based configurable CLI tool for standardizing Git commit messages. It offers an interactive prompt that guides you through the process of composing a commit message that adheres to conventional commit formats. Gommitizen also includes commands for installing itself as a Git subcommand, checking version information, and more.
.
├── CHANGELOG # Project changelog
├── cmd
│ ├── options.go # Install, reinstall, uninstall, and version commands
│ └── version.go # Version management
├── configs
│ └── default.json # Default commit form configuration (JSON)
├── go.mod # Go module definition
├── gommitizen # Built binary (after build)
├── internal
│ ├── changelog.go # Changelog generation
│ ├── commit.go # Commit message generation and execution
│ ├── config.go # Load and render config from configs/default.json
│ ├── lint.go # Commit message linter
│ └── utils # Terminal UI and utilities
│ ├── term_darwin.go # Terminal handling for macOS
│ ├── term_linux.go # Terminal handling for Linux
│ ├── text_mods.go # Text formatting utilities (colors, underline, highlight)
│ └── tui.go # Terminal UI (TUI) core logic
├── LICENSE # License file (MIT)
├── main.go # Application entry point
├── README.md # Project documentation
└── VERSION # Current app version
git clone https://github.com/tiendu/gommitizen.git
cd gommitizen
This will install gommitizen into ~/.local/bin/gommitizen and copy the config.
go build -o gommitizen
./gommitizen installYou can specify a custom installation path:
./gommitizen install --path /your/custom/pathNOTE: Make sure to add your install path to your PATH environment variable!
After installation, you'll have git-cz command available globally.
git-cz commitLaunches an interactive prompt to compose your commit message.
# Lint all commit messages in the repository
git-cz lint --all
git-cz lint -a
# Lint only the latest commit message
git-cz lint --current
git-cz lint -c
# Optionally, lint a specific commit message string directly
git-cz lint "your commit message here"git-cz install # Install gommitizen
git-cz reinstall # Reinstall gommitizen
git-cz uninstall # Uninstall gommitizenUpon installation, gommitizen copies the config to:
~/.local/bin/gommitizen/configs/default.jsonYou can edit this file to customize:
- Commit types
- Prompts
- Commit message templates
If no config file is found, gommitizen will use its built-in default config.