Install via Nix

Install git-cliff using Nix for reproducible, declarative package management.

Quick Start

nix-shell
nix-env
nix run
nix shell

Temporarily use git-cliff:

nix-shell -p git-cliff

This opens a shell with git-cliff available.

Install permanently:

nix-env -iA nixpkgs.git-cliff

Run without installing (new CLI):

nix run nixpkgs#git-cliff

Open a shell with git-cliff (new CLI):

nix shell nixpkgs#git-cliff

Installation Methods

Traditional Nix Commands

Using nix-shell (Recommended)

Temporarily add git-cliff to your environment:

nix-shell -p git-cliff

This creates an isolated environment with git-cliff available.To use it:

git-cliff --version

Using nix-env

Install git-cliff permanently:

nix-env -iA nixpkgs.git-cliff

Using nix-env permanently modifies a local profile. Consider using nix-shell or NixOS configuration instead for better reproducibility.

Verify installation

git-cliff --version

New Nix CLI (Experimental)

The new Nix CLI requires enabling experimental features. Add to ~/.config/nix/nix.conf:

experimental-features = nix-command flakes

nix run
nix shell
nix profile

Run git-cliff directly without installing:

nix run nixpkgs#git-cliff

With arguments:

nix run nixpkgs#git-cliff -- --help
nix run nixpkgs#git-cliff -- -o CHANGELOG.md

Open a shell with git-cliff available:

nix shell nixpkgs#git-cliff

Multiple packages:

nix shell nixpkgs#git-cliff nixpkgs#git

Install to your profile:

nix profile install nixpkgs#git-cliff

List installed packages:

nix profile list

Remove:

nix profile remove git-cliff

NixOS Configuration

Add git-cliff to your system configuration:

configuration.nix
home-manager
Flakes

Add to /etc/nixos/configuration.nix:

{ config, pkgs, ... }:

{
  environment.systemPackages = with pkgs; [
    git-cliff
    # other packages...
  ];
}

Rebuild your system:

sudo nixos-rebuild switch

Add to your home-manager configuration:

home.nix

{ config, pkgs, ... }:

{
  home.packages = with pkgs; [
    git-cliff
  ];
}

Apply changes:

home-manager switch

In your flake.nix:

{
  description = "My system configuration";
  
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
  };
  
  outputs = { self, nixpkgs }: {
    nixosConfigurations.myhost = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        ({ pkgs, ... }: {
          environment.systemPackages = [ pkgs.git-cliff ];
        })
      ];
    };
  };
}

Development Shell

Create a development environment with git-cliff:

shell.nix
flake.nix

Create shell.nix in your project:

{ pkgs ? import <nixpkgs> {} }:

pkgs.mkShell {
  buildInputs = with pkgs; [
    git-cliff
    git
  ];
  
  shellHook = ''
    echo "git-cliff $(git-cliff --version)"
    echo "Development environment ready!"
  '';
}

Enter the shell:

nix-shell

Create flake.nix for your project:

{
  description = "Development environment with git-cliff";
  
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    flake-utils.url = "github:numtide/flake-utils";
  };
  
  outputs = { self, nixpkgs, flake-utils }:
    flake-utils.lib.eachDefaultSystem (system:
      let
        pkgs = nixpkgs.legacyPackages.${system};
      in
      {
        devShells.default = pkgs.mkShell {
          buildInputs = with pkgs; [
            git-cliff
            git
          ];
          
          shellHook = ''
            echo "git-cliff development environment"
            git-cliff --version
          '';
        };
      }
    );
}

Enter the development shell:

nix develop

Channel Management

Using Stable Channel

git-cliff is available in the stable channel:

nix-shell -p git-cliff

Using Unstable Channel

For the latest features, use the unstable channel:

Add unstable channel

nix-channel --add https://nixos.org/channels/nixpkgs-unstable
nix-channel --update nixpkgs

Install from unstable

nix-env -iA nixpkgs.git-cliff

Managing Installation

# Using nix-env
nix-env -q | grep git-cliff

# Using nix profile (new CLI)
nix profile list | grep git-cliff

Troubleshooting

Command not found after installation

Ensure your Nix profile is in your PATH:

echo $PATH | grep nix

Add to your shell configuration (~/.bashrc, ~/.zshrc, etc.):

export PATH="$HOME/.nix-profile/bin:$PATH"

Or source the Nix profile:

. ~/.nix-profile/etc/profile.d/nix.sh

Experimental features not enabled

To use the new Nix CLI commands, enable experimental features:Permanently:Create/edit ~/.config/nix/nix.conf:

experimental-features = nix-command flakes

Temporarily:

nix --experimental-features 'nix-command flakes' run nixpkgs#git-cliff

Package not found

Update your channels:

nix-channel --update

Or search for the package:

nix search nixpkgs git-cliff

Try the unstable channel if not found in stable.

Permission denied errors

Nix should not require sudo for most operations. If you get permission errors:

Ensure Nix is properly installed:
```
nix --version
```
Check Nix daemon is running (multi-user install):
```
sudo systemctl status nix-daemon
```

Reinstall Nix if needed:

sh <(curl -L https://nixos.org/nix/install) --daemon

Old version installed

If you’re getting an older version:

Update channels:
```
nix-channel --update
```

Reinstall:

nix-env -e git-cliff
nix-env -iA nixpkgs.git-cliff

Or use unstable channel:

nix-channel --add https://nixos.org/channels/nixpkgs-unstable
nix-channel --update
nix-env -iA nixpkgs.git-cliff

Why Use Nix?

Reproducibility

Nix ensures exact reproducibility. The same configuration always produces the same result.

Declarative

Define your environment declaratively. Share configurations across machines.

Rollbacks

Easily rollback to previous configurations if something breaks.

Isolation

Packages are isolated. No conflicts between versions or dependencies.

Next Steps

Configuration

Configure git-cliff for your project

Nix Flakes

Learn about Nix Flakes

Get Started

Installation

Usage

Configuration

Templating

Install via Nix

Install via Nix

Quick Start

Installation Methods

Traditional Nix Commands

New Nix CLI (Experimental)

NixOS Configuration

Development Shell

Channel Management

Using Stable Channel

Using Unstable Channel

Managing Installation

Troubleshooting

Why Use Nix?

Reproducibility

Declarative

Rollbacks

Isolation

Next Steps

Configuration

Nix Flakes

Build docs developers (and LLMs) love

Get Started

Installation

Usage

Configuration

Templating

​Install via Nix

​Quick Start

​Installation Methods

​Traditional Nix Commands

​New Nix CLI (Experimental)

​NixOS Configuration

​Development Shell

​Channel Management

​Using Stable Channel

​Using Unstable Channel

​Managing Installation

​Troubleshooting

​Why Use Nix?

Reproducibility

Declarative

Rollbacks

Isolation

​Next Steps

Configuration

Nix Flakes

Build docs developers (and LLMs) love

Install via Nix

Quick Start

Installation Methods

Traditional Nix Commands

New Nix CLI (Experimental)

NixOS Configuration

Development Shell

Channel Management

Using Stable Channel

Using Unstable Channel

Managing Installation

Troubleshooting

Why Use Nix?

Next Steps