Skip to content

Commit

Permalink
docs(nix): add installation instructions for Nix (#669)
Browse files Browse the repository at this point in the history
  • Loading branch information
0x61nas authored Jun 2, 2024
1 parent 8ffc054 commit 63c8ad4
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions website/docs/installation/nix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
sidebar_position: 4
---
# Nix

If you are using Nix, **git-cliff** can be installed from the [official latest staple channel][channel-link].

## Using nix-shell

To temporarily install git-cliff in a shell environment, run:

```sh
nix-shell -p git-cliff
```

## Using nix-env

To install git-cliff permanently, use:

```sh
nix-env -iA nixpkgs.git-cliff
```

> [!WARNING]
> Using nix-env permanently modifies a local profile of installed packages.
> This must be updated and maintained by the user in the same way as with a traditional package manager,
> foregoing many of the benefits that make Nix uniquely powerful.
> Using nix-shell or a NixOS configuration is recommended instead.

## The new CLI

If you're using the new experimental CLI, you can use any of the following:

### `nix run
```sh
nix run nixpkgs#git-cliff
```

### `nix shell`

To open a new shell with git-cliff available, use:

```sh
nix shell nixpkgs#git-cliff
```

## Using the Unstable Channel

While new releases of **git-cliff** typically become available in the stable channel relatively quickly, you can use the unstable channel if you want to access the latest features and updates sooner.

To add and update the unstable channel, run:

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

After updating to the unstable channel, you can use any of the previous installation commands to install **git-cliff**.


[channel-link]: https://search.nixos.org/packages?channel=24.05&show=git-cliff&from=0&size=50&sort=relevance&type=packages&query=git-cliff

0 comments on commit 63c8ad4

Please sign in to comment.