.\" -*- mode: troff; coding: utf-8 -*-
.TH "nix3-profile-list" "1" ""
.RS
.PP
\fBWarning\fR 
.br
This program is
\fB\fBexperimental\fR\fR
and its interface is subject to change.
.RE
.SH
Name
.LP
\fCnix profile list\fR - list installed packages
.SH
Synopsis
.LP
\fCnix profile list\fR [\fIoption\fR\[u2026]] 
.SH
Examples
.IP "\(bu" 3
Show what packages are installed in the default profile:
.LP
.EX
# nix profile list
Name:               gdb
Flake attribute:    legacyPackages.x86_64-linux.gdb
Original flake URL: flake:nixpkgs
Locked flake URL:   github:NixOS/nixpkgs/7b38b03d76ab71bdc8dc325e3f6338d984cc35ca
Store paths:        /nix/store/indzcw5wvlhx6vwk7k4iq29q15chvr3d-gdb-11.1

Name:               blender-bin
Flake attribute:    packages.x86_64-linux.default
Original flake URL: flake:blender-bin
Locked flake URL:   github:edolstra/nix-warez/91f2ffee657bf834e4475865ae336e2379282d34?dir=blender
Store paths:        /nix/store/i798sxl3j40wpdi1rgf391id1b5klw7g-blender-bin-3.1.2
.EE
.IP
Note that you can unambiguously rebuild a package from a profile
through its locked flake URL and flake attribute, e.g.
.LP
.EX
# nix build github:edolstra/nix-warez/91f2ffee657bf834e4475865ae336e2379282d34?dir=blender#packages.x86_64-linux.default
.EE
.IP
will build the package \fCblender-bin\fR shown above.
.SH
Description
.LP
This command shows what packages are currently installed in a
profile. For each installed package, it shows the following
information:
.IP "\(bu" 3
\fCName\fR: A unique name used to unambiguously identify the
package in invocations of \fCnix profile remove\fR and \fCnix profile
upgrade\fR.
.IP "\(bu" 3
\fCIndex\fR: An integer that can be used to unambiguously identify the
package in invocations of \fCnix profile remove\fR and \fCnix profile upgrade\fR.
(\fIDeprecated, will be removed in a future version in favor of \f(CIName\fI.\fR)
.IP "\(bu" 3
\fCFlake attribute\fR: The flake output attribute path that provides the
package (e.g. \fCpackages.x86_64-linux.hello\fR).
.IP "\(bu" 3
\fCOriginal flake URL\fR: The original (\(lqunlocked\(rq) flake reference
specified by the user when the package was first installed via \fCnix
profile install\fR.
.IP "\(bu" 3
\fCLocked flake URL\fR: The locked flake reference to which the original
flake reference was resolved.
.IP "\(bu" 3
\fCStore paths\fR: The store path(s) of the package.
.SH
Options
.IP "\(bu" 3
\fB\fC--json\fR\fR
.IP
Produce output in JSON format, suitable for consumption by another program.
.IP "\(bu" 3
\fB\fC--profile\fR\fR \fIpath\fR
.IP
The profile to operate on.
.SS
Common evaluation options
.IP "\(bu" 3
\fB\fC--arg\fR\fR \fIname\fR \fIexpr\fR
.IP
Pass the value \fIexpr\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\fC--arg-from-file\fR\fR \fIname\fR \fIpath\fR
.IP
Pass the contents of file \fIpath\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\fC--arg-from-stdin\fR\fR \fIname\fR
.IP
Pass the contents of stdin as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\fC--argstr\fR\fR \fIname\fR \fIstring\fR
.IP
Pass the string \fIstring\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 3
\fB\fC--debugger\fR\fR
.IP
Start an interactive environment if evaluation fails.
.IP "\(bu" 3
\fB\fC--eval-store\fR\fR \fIstore-url\fR
.IP
The \fBURL of the Nix store\fR
to use for evaluation, i.e. to store derivations (\fC.drv\fR files) and inputs referenced by them.
.IP "\(bu" 3
\fB\fC--impure\fR\fR
.IP
Allow access to mutable paths and repositories.
.IP "\(bu" 3
\fB\fC--include\fR\fR / \fC-I\fR \fIpath\fR
.IP
Add \fIpath\fR to the Nix search path. The Nix search path is
initialized from the colon-separated \fB\fCNIX_PATH\fR\fR environment
variable, and is used to look up the location of Nix expressions using \fBpaths\fR enclosed in angle
brackets (i.e., \fC<nixpkgs>\fR).
.IP
For instance, passing
.LP
.EX
-I /home/eelco/Dev
-I /etc/nixos
.EE
.IP
will cause Nix to look for paths relative to \fC/home/eelco/Dev\fR and
\fC/etc/nixos\fR, in that order. This is equivalent to setting the
\fCNIX_PATH\fR environment variable to
.LP
.EX
/home/eelco/Dev:/etc/nixos
.EE
.IP
It is also possible to match paths against a prefix. For example,
passing
.LP
.EX
-I nixpkgs=/home/eelco/Dev/nixpkgs-branch
-I /etc/nixos
.EE
.IP
will cause Nix to search for \fC<nixpkgs/path>\fR in
\fC/home/eelco/Dev/nixpkgs-branch/path\fR and \fC/etc/nixos/nixpkgs/path\fR.
.IP
If a path in the Nix search path starts with \fChttp://\fR or \fChttps://\fR,
it is interpreted as the URL of a tarball that will be downloaded and
unpacked to a temporary location. The tarball must consist of a single
top-level directory. For example, passing
.LP
.EX
-I nixpkgs=https://github.com/NixOS/nixpkgs/archive/master.tar.gz
.EE
.IP
tells Nix to download and use the current contents of the \fCmaster\fR
branch in the \fCnixpkgs\fR repository.
.IP
The URLs of the tarballs from the official \fCnixos.org\fR channels
(see \fBthe manual page for \fCnix-channel\fR\fR) can be
abbreviated as \fCchannel:<channel-name>\fR. For instance, the
following two flags are equivalent:
.LP
.EX
-I nixpkgs=channel:nixos-21.05
-I nixpkgs=https://nixos.org/channels/nixos-21.05/nixexprs.tar.xz
.EE
.IP
You can also fetch source trees using \fBflake URLs\fR and add them to the
search path. For instance,
.LP
.EX
-I nixpkgs=flake:nixpkgs
.EE
.IP
specifies that the prefix \fCnixpkgs\fR shall refer to the source tree
downloaded from the \fCnixpkgs\fR entry in the flake registry. Similarly,
.LP
.EX
-I nixpkgs=flake:github:NixOS/nixpkgs/nixos-22.05
.EE
.IP
makes \fC<nixpkgs>\fR refer to a particular branch of the
\fCNixOS/nixpkgs\fR repository on GitHub.
.IP "\(bu" 3
\fB\fC--override-flake\fR\fR \fIoriginal-ref\fR \fIresolved-ref\fR
.IP
Override the flake registries, redirecting \fIoriginal-ref\fR to \fIresolved-ref\fR.
.SS
Logging-related options
.IP "\(bu" 3
\fB\fC--debug\fR\fR
.IP
Set the logging verbosity level to \(oqdebug\(cq.
.IP "\(bu" 3
\fB\fC--log-format\fR\fR \fIformat\fR
.IP
Set the format of log output; one of \fCraw\fR, \fCinternal-json\fR, \fCbar\fR or \fCbar-with-logs\fR.
.IP "\(bu" 3
\fB\fC--print-build-logs\fR\fR / \fC-L\fR
.IP
Print full build logs on standard error.
.IP "\(bu" 3
\fB\fC--quiet\fR\fR
.IP
Decrease the logging verbosity level.
.IP "\(bu" 3
\fB\fC--verbose\fR\fR / \fC-v\fR
.IP
Increase the logging verbosity level.
.SS
Miscellaneous global options
.IP "\(bu" 3
\fB\fC--help\fR\fR
.IP
Show usage information.
.IP "\(bu" 3
\fB\fC--offline\fR\fR
.IP
Disable substituters and consider all previously downloaded files up-to-date.
.IP "\(bu" 3
\fB\fC--option\fR\fR \fIname\fR \fIvalue\fR
.IP
Set the Nix configuration setting \fIname\fR to \fIvalue\fR (overriding \fCnix.conf\fR).
.IP "\(bu" 3
\fB\fC--refresh\fR\fR
.IP
Consider all previously downloaded files out-of-date.
.IP "\(bu" 3
\fB\fC--repair\fR\fR
.IP
During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
.IP "\(bu" 3
\fB\fC--version\fR\fR
.IP
Show version information.
.RS
.LP
\fBNote\fR
.PP
See \fB\fCman nix.conf\fR\fR for overriding configuration settings with command line flags.
.RE