Install from Binary
Download pre-compiled binaries for the fastest installation with no dependencies.Quick Install
- Linux
- macOS
- Windows
Download and install the latest binary:
Detailed Installation Steps
Choose your platform
Download the appropriate binary from the releases page:Linux:
x86_64-unknown-linux-gnu.tar.gz(glibc-based systems like Ubuntu, Debian, Fedora)x86_64-unknown-linux-musl.tar.gz(musl-based systems like Alpine Linux)aarch64-unknown-linux-gnu.tar.gz(ARM64 Linux)
x86_64-apple-darwin.tar.gz(Intel Macs)aarch64-apple-darwin.tar.gz(Apple Silicon M1/M2/M3)
x86_64-pc-windows-msvc.zip(64-bit Windows)
Extract the archive
git-cliff- The binary executableREADME.md- DocumentationLICENSE-*- License files
Install the binary
Move the binary to a directory in your PATH:
Ensure
~/.local/bin is in your PATH if using user-local installation.Signature Verification
Release tarballs are signed with PGP key:
1D2D410A741137EBC544826F4A92FA17B6619297Troubleshooting
Permission denied when running git-cliff
Permission denied when running git-cliff
Make the binary executable:
Binary not found after installation
Binary not found after installation
Ensure the installation directory is in your PATH:Add to PATH if needed:Make it permanent by adding to
~/.bashrc or ~/.zshrc.GLIBC version error on Linux
GLIBC version error on Linux
If you see errors about GLIBC version, try the musl binary:The musl binary is statically linked and works on older Linux distributions.
macOS blocks the binary (Apple Silicon)
macOS blocks the binary (Apple Silicon)
If macOS blocks the binary due to security settings:Or go to System Preferences → Security & Privacy and allow the app.
Windows Defender blocks the binary
Windows Defender blocks the binary
Windows Defender may flag the binary. This is a false positive. You can:
- Add an exception in Windows Defender
- Download from the official GitHub releases page
- Verify the binary’s hash from the releases page
Updating
To update, simply download the latest version and replace the old binary:Next Steps
Configuration
Set up git-cliff for your project
Usage Examples
Learn how to use git-cliff