Installation Overview
git-cliff is available through multiple package managers and installation methods. Choose the one that best fits your workflow.Quick Comparison
| Method | Platform | Best For | Installation Time |
|---|---|---|---|
| Cargo | All | Rust developers, latest features | ~2-3 minutes |
| Binary | All | Quick setup, no dependencies | ~30 seconds |
| NPM | All | Node.js projects, programmatic API | ~1 minute |
| PyPI | All | Python projects | ~30 seconds |
| Pacman | Arch Linux | Arch users, official repos | ~10 seconds |
| Docker | All | Containers, CI/CD | ~1 minute |
| Homebrew | macOS/Linux | macOS users, easy updates | ~1 minute |
| Nix | NixOS/Linux/macOS | Reproducible builds | ~30 seconds |
Installation Methods
Cargo
Install from crates.io with full feature control
Binary
Download pre-built binaries for your platform
NPM
Install via npm with TypeScript API support
PyPI
Install using pip for Python projects
Pacman
Official Arch Linux package
Docker
Run in containers with Docker Hub images
Homebrew
Install on macOS using Homebrew
Nix
Install with Nix package manager
Recommendations
- For Rust Developers
- For Quick Setup
- For JavaScript/TypeScript
- For Python Projects
- For macOS
- For Containers
Use Cargo for the most flexibility:
- Access to latest features
- Control over feature flags
- Easy updates with
cargo install - Integrates with Rust toolchain
Verifying Installation
After installation, verify git-cliff is working:Next Steps
Configuration
Learn how to configure git-cliff for your project
Usage Examples
See practical examples and common use cases