Install via Cargo
Install git-cliff from crates.io using Cargo, Rust’s package manager.
Prerequisites
Minimum supported Rust version: 1.85.1
rustc --version
cargo --version
Installation
Install from crates.io
Install the latest stable version:This will download, compile, and install git-cliff with all default features enabled. Verify installation
Check that git-cliff is installed correctly:Expected output: Test the installation
Run git-cliff in a git repository:cd /path/to/your/git/repo
git-cliff --help
Advanced Installation
Latest Git Version
Custom Features
Specific Version
Force Reinstall
Install the bleeding-edge version from the main branch:cargo install --git https://github.com/orhun/git-cliff
The git version may contain unreleased features and potential bugs.
git-cliff supports several feature flags:| Feature | Description |
|---|
update-informer | Notifies about new releases |
github | Enables GitHub integration |
gitlab | Enables GitLab integration |
gitea | Enables Gitea integration |
bitbucket | Enables Bitbucket integration |
integrations | Enables all integrations |
Install without default features
cargo install git-cliff --no-default-features
Install with specific features
Enable only the update notifier:cargo install git-cliff --no-default-features --features update-informer
cargo install git-cliff --no-default-features --features github
cargo install git-cliff --no-default-features --features "github,gitlab,update-informer"
Install a specific version:cargo install git-cliff --version 2.7.0
Force reinstall to update or fix installation:cargo install git-cliff --force
Updating
Update to the latest version:
cargo install git-cliff --force
cargo install cargo-update
cargo install-update git-cliff
Uninstalling
Remove git-cliff:
cargo uninstall git-cliff
Troubleshooting
Compilation fails with linker errors
Ensure you have the necessary build tools:Linux (Debian/Ubuntu):sudo apt-get install build-essential pkg-config libssl-dev
sudo dnf install gcc pkg-config openssl-devel
Binary not found after installation
Cargo installs binaries to ~/.cargo/bin/. Ensure this is in your PATH:Bash/Zsh:echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
set -U fish_user_paths $HOME/.cargo/bin $fish_user_paths
Update Rust to the minimum supported version:Check your Rust version:
Speed up compilation by using more CPU cores:cargo install git-cliff -j $(nproc)
Next Steps
Configuration
Learn how to configure git-cliff
Usage Examples
See practical examples