Using Nix: nix-env

From CC Doc
Jump to navigation Jump to search
This site replaces the former Compute Canada documentation site, and is now being managed by the Digital Research Alliance of Canada.

Ce site remplace l'ancien site de documentation de Calcul Canada et est maintenant géré par l'Alliance de recherche numérique du Canada.

This article is a draft

This is not a complete article: This is a Draft, a work in progress that is intended to be published into an article, which may or may not be ready for inclusion in the main wiki. It should not necessarily be considered factual or authoritative.

This page details using the legacy nix-env command to manage a per-user environment. For an overview of Nix, start with our using nix page.

Querying, installing and removing compositions

The nix-env command is used to manage your per-user Nix environment. It is actually a legacy command that has not yet been replaced by a newer nix <command> command.

What do I have installed and what can I install

Lets first see what we currently have installed.

[name@cluster:~]$ nix-env --query

Now let’s see what is available. We request the attribute paths (unambiguous way of specifying an existing composition) and the descriptions too (cursor to the right to see them). This takes a bit of time as it visits a lot of small files. Especially over NFS it can be a good idea to pipe it to a file and then grep that in the future.

[name@cluster:~]$ nix-env --query --available --attr-path --description

The newer nix search command is often a better way to locate compositions as it saves a cache so subsequent invocations are quite fast.

Installing compositions

Let’s say that we need a newer version of git than provided by default. First lets check what our OS comes with.

[name@cluster:~]$ git --version
[name@cluster:~]$ which git

Let’s tell Nix to install its version in our environment.

[name@cluster:~]$ nix-env --install --attr nixpkgs.git
[name@cluster:~]$ nix-env --query

Let’s checkout what we have now (it may be necessary to tell bash to to forget remembered executable locations with hash -r so it notices the new one).

[name@cluster:~]$ git --version
[name@cluster:~]$ which git

Removing compositions

For completeness, lets add in the other usual version-control suspects.

[name@cluster:~]$ nix-env --install --attr nixpkgs.subversion nixpkgs.mercurial
[name@cluster:~]$ nix-env --query

Actually, we probably don’t really want subversion any more. Let’s remove that.

[name@cluster:~]$ nix-env --uninstall subversion
[name@cluster:~]$ nix-env --query


Nix keeps referring to user environments. Each time we install or remove compositions we create a new environment based off of the previous environment.

Switching between previous environments

This means the previous environments still exist and we can switch back to them at any point. Let’s say we changed our mind and want subversion back. It’s trivial to restore the previous environment.

[name@cluster:~]$ nix-env --rollback
[name@cluster:~]$ nix-env --query

Of course we may want to do more than just move to the previous environment. We can get a list of all our environments so far and then jump directly to whatever one we want. Let’s undo the rollback.

[name@cluster:~]$ nix-env --list-generations
[name@cluster:~]$ nix-env --switch-generation 4
[name@cluster:~]$ nix-env --query

Operations are atomic

Due to the atomic property of Nix environments, we can’t be left halfway through installing/updating compositions. They either succeed and create us a new environment or leave us with the previous one intact.

Let’s go back to the start when we just had Nix itself and install the one true GNU distributed version control system tla. Don’t let it complete though. Hit it with CTRL+c partway through.

[name@cluster:~]$ nix-env --switch-generation 1
[name@cluster:~]$ nix-env --install --attr nixpkgs.tla

Nothing bad happens. The operation didn’t complete so it has no effect on the environment whatsoever.

[name@cluster:~]$ nix-env --query
[name@cluster:~]$ nix-env --list-generations

Nix only does things once

The install and remove commands take the current environment and create a new environment with the changes. This works regardless of which environment we are currently in. Let’s create a new environment from our original environment by just adding git and mercurial.

[name@cluster:~]$ nix-env --list-generations
[name@cluster:~]$ nix-env --install --attr nixpkgs.git nixpkgs.mercurial
[name@cluster:~]$ nix-env --list-generations

Notice how much much faster it was to install git and mercurial the second time? That is because the software already existed in the local Nix store from the previous installs so Nix just reused it.

Garbage collection

Nix periodically goes through and removes any software not accessible from any existing environments. This means we have to explicitly delete environments we don’t want anymore so Nix is able to reclaim the space. We can delete specific environments or any sufficiently old.

[name@cluster:~]$ nix-env --delete-generations 30d