nixos-manual-mdx/pages/basic-package-management.mdx

export const meta = {
	title: "Basic package management"
};

import DistroSpecific from "./components/distro-specific";
import Note from "./components/note";
import Reference from "./components/reference";
import Placeholder from "./components/placeholder";
import Command from "./components/command";

# Basic package management

The main command for package management is <Command>nix-env</Command>. You can use it to install, upgrade and erase packages, and to query what
packages are installed or are available for installation.

In Nix, different users can have different “views” on the set of installed applications. That is, there might be lots of applications present on the system (possibly in many different versions), but users can have a specific selection of those active — where “active” just means that it appears in a directory in the user’s `PATH`. Such a view on the set of installed applications is called a __user environment__, which is just a directory tree consisting of symlinks to the files of the active applications.

Components are installed from a set of __Nix expressions__ that tell Nix how to build those packages, including, if necessary, their dependencies.  There is a collection of Nix expressions called the Nixpkgs package collection that contains packages ranging from basic development stuff such as GCC and Glibc, to end-user applications like Mozilla Firefox. (Nix is however not tied to the Nixpkgs package collection; you could write your own Nix expressions based on Nixpkgs, or completely new ones.)

You can manually download the latest version of Nixpkgs from http://nixos.org/nixpkgs/download.html. However, it’s much more convenient to use the Nixpkgs __channel__, since it makes it easy to stay up to date with new versions of Nixpkgs. (Channels are described in more detail in <Reference path="channels" />.) Nixpkgs is automatically added to your list of “subscribed” channels when you install Nix. If this is not the case for some reason, you can add it as follows:

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

<DistroSpecific>

On NixOS, you’re automatically subscribed to a NixOS channel corresponding to your NixOS major release (e.g. `http://nixos.org/channels/nixos-14.12`). A NixOS
channel is identical to the Nixpkgs channel, except that it contains only Linux binaries and is updated only if a set of regression tests succeed.

</DistroSpecific>

You can view the set of available packages in Nixpkgs:

```shell
$ nix-env -qa
aterm-2.2
bash-3.0
binutils-2.15
bison-1.875d
blackdown-1.4.2
bzip2-1.0.2
...
```

The flag `-q` specifies a query operation, and `-a` means that you want to show the “available” (i.e., installable) packages, as opposed to the installed packages. If you
downloaded Nixpkgs yourself, or if you checked it out from GitHub, then you need to pass the path to your Nixpkgs tree using the `-f` flag:

```shell
$ nix-env -qaf <Placeholder>/path/to/nixpkgs</Placeholder>
```

... where <Placeholder>/path/to/nixpkgs</Placeholder> is where you’ve unpacked or checked out Nixpkgs.

You can select specific packages by name:

```shell
$ nix-env -qa firefox
firefox-34.0.5
firefox-with-plugins-34.0.5
```

and using regular expressions:

```shell
$ nix-env -qa 'firefox.*'
```

It is also possible to see the __status__ of available packages, i.e., whether they are installed into the user environment and/or present in the system:

```shell
$ nix-env -qas
...
-PS bash-3.0
--S binutils-2.15
IPS bison-1.875d
```

The first character (`I`) indicates whether the package is installed in your current user environment. The second (`P`) indicates whether it is present on your system (in which case installing it into your user environment would be a very quick operation). The last one (`S`) indicates whether there is a so-called __substitute__ for the package, which is Nix’s mechanism for doing binary deployment. It just means that Nix knows that it can fetch a pre-built package from somewhere (typically a network server) instead of building it locally.

You can install a package using `nix-env -i`.

For instance,

```shell
$ nix-env -i subversion
```

... will install the package called `subversion` (which is, of course, the [Subversion version
management system](http://subversion.tigris.org/)).

<Note>

When you ask Nix to install a package, it will first try to get it in pre-compiled form from a __binary cache__. By default, Nix will use the binary cache https://cache.nixos.org; it contains binaries for most packages in Nixpkgs. Only if no binary is available in the binary cache, Nix will build the package from source. So if `nix-env -i subversion` results in Nix building stuff from source, then either the package is not built for your platform by the Nixpkgs build servers, or your version of Nixpkgs is too old or too new.

For instance, if you have a very recent checkout of Nixpkgs, then the Nixpkgs build servers may not have had a chance to build everything and upload the resulting binaries to https://cache.nixos.org. The Nixpkgs channel is only updated after all binaries have been uploaded to the cache, so if you stick to the Nixpkgs channel (rather than using a Git checkout of the Nixpkgs tree), you will get binaries for most packages.

</Note>

Naturally, packages can also be uninstalled:

```shell
$ nix-env -e subversion
```

Upgrading to a new version is just as easy. If you have a new release of Nix Packages, you can do:

```shell
$ nix-env -u subversion
```

This will __only__ upgrade Subversion if there is a “newer” version in the new set of Nix expressions, as defined by some pretty arbitrary rules regarding ordering of version numbers (which generally do what you’d expect of them). To just unconditionally replace Subversion with whatever version is in the Nix expressions, use `-i` instead of `-u`; `-i` will remove whatever version is already installed.

You can also upgrade all packages for which there are newer versions:

```shell
$ nix-env -u
```

Sometimes it’s useful to be able to ask what `nix-env` would do, without actually doing it. For instance, to find out what packages would be upgraded by `nix-env -u`, you can do:

```shell
$ nix-env -u --dry-run
(dry run; not doing anything)
upgrading `libxslt-1.1.0' to `libxslt-1.1.10'
upgrading `graphviz-1.10' to `graphviz-1.12'
upgrading `coreutils-5.0' to `coreutils-5.2.1'
```