.\" -*- mode: troff; coding: utf-8 -*-
.TH "nix3-search" "1" ""
.PP
\fBWarning\fR: This program is \fBexperimental\fR and its interface is subject to change.
.SH Name
\fCnix search\fR - search for packages
.SH Synopsis
\fCnix search\fR [\fIoption\fR\[u2026]] \fIinstallable\fR \fIregex\fR\[u2026]
.SH Examples
.IP "\(bu" 2
Show all packages in the \fCnixpkgs\fR flake:
.LP
.EX
# nix search nixpkgs
* legacyPackages.x86_64-linux.AMB-plugins (0.8.1)
A set of ambisonics ladspa plugins

* legacyPackages.x86_64-linux.ArchiSteamFarm (4.3.1.0)
Application with primary purpose of idling Steam cards from multiple accounts simultaneously
…
.EE
.IP "\(bu" 2
Show packages in the \fCnixpkgs\fR flake containing \fCblender\fR in its
name or description:
.LP
.EX
# nix search nixpkgs blender
* legacyPackages.x86_64-linux.blender (2.91.0)
3D Creation/Animation/Publishing System
.EE
.IP "\(bu" 2
Search for packages underneath the attribute \fCgnome3\fR in Nixpkgs:
.LP
.EX
# nix search nixpkgs#gnome3 vala
* legacyPackages.x86_64-linux.gnome3.vala (0.48.9)
Compiler for GObject type system
.EE
.IP "\(bu" 2
Show all packages in the flake in the current directory:
.LP
.EX
# nix search
.EE
.IP "\(bu" 2
Search for Firefox or Chromium:
.LP
.EX
# nix search nixpkgs 'firefox|chromium'
.EE
.IP "\(bu" 2
Search for packages containing \fCgit'\fRand either \fCfrontend\fR or \fCgui\fR:
.LP
.EX
# nix search nixpkgs git 'frontend|gui'
.EE
.SH Description
\fCnix search\fR searches \fIinstallable\fR (which must be evaluatable, e.g. a
flake) for packages whose name or description matches all of the
regular expressions \fIregex\fR.  For each matching package, It prints the
full attribute name (from the root of the installable), the version
and the \fCmeta.description\fR field, highlighting the substrings that
were matched by the regular expressions. If no regular expressions are
specified, all packages are shown.
.SH Flake output attributes
If no flake output attribute is given, \fCnix search\fR searches for
packages:
.IP "\(bu" 2
Directly underneath \fCpackages.<system>\fR.
.IP "\(bu" 2
Underneath \fClegacyPackages.<system>\fR, recursing into attribute sets
that contain an attribute \fCrecurseForDerivations = true\fR.
.SH Options
.IP "\(bu" 2
\fC--json\fR
.br
Produce output in JSON format, suitable for consumption by another program.
.LP
\fBCommon evaluation options:\fR
.IP "\(bu" 2
\fC--arg\fR \fIname\fR \fIexpr\fR
.br
Pass the value \fIexpr\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 2
\fC--argstr\fR \fIname\fR \fIstring\fR
.br
Pass the string \fIstring\fR as the argument \fIname\fR to Nix functions.
.IP "\(bu" 2
\fC--eval-store\fR \fIstore-url\fR
.br
The Nix store to use for evaluations.
.IP "\(bu" 2
\fC--impure\fR
.br
Allow access to mutable paths and repositories.
.IP "\(bu" 2
\fC--include\fR / \fC-I\fR \fIpath\fR
.br
Add \fIpath\fR to the list of locations used to look up \fC<...>\fR file names.
.IP "\(bu" 2
\fC--override-flake\fR \fIoriginal-ref\fR \fIresolved-ref\fR
.br
Override the flake registries, redirecting \fIoriginal-ref\fR to \fIresolved-ref\fR.
.LP
\fBCommon flake-related options:\fR
.IP "\(bu" 2
\fC--commit-lock-file\fR
.br
Commit changes to the flake\[u2019]s lock file.
.IP "\(bu" 2
\fC--inputs-from\fR \fIflake-url\fR
.br
Use the inputs of the specified flake as registry entries.
.IP "\(bu" 2
\fC--no-registries\fR
.br
Don\[u2019]t allow lookups in the flake registries. This option is deprecated; use \fC--no-use-registries\fR.
.IP "\(bu" 2
\fC--no-update-lock-file\fR
.br
Do not allow any updates to the flake\[u2019]s lock file.
.IP "\(bu" 2
\fC--no-write-lock-file\fR
.br
Do not write the flake\[u2019]s newly generated lock file.
.IP "\(bu" 2
\fC--override-input\fR \fIinput-path\fR \fIflake-url\fR
.br
Override a specific flake input (e.g. \fCdwarffs/nixpkgs\fR). This implies \fC--no-write-lock-file\fR.
.IP "\(bu" 2
\fC--recreate-lock-file\fR
.br
Recreate the flake\[u2019]s lock file from scratch.
.IP "\(bu" 2
\fC--update-input\fR \fIinput-path\fR
.br
Update a specific flake input (ignoring its previous entry in the lock file).
.LP
\fBOptions that change the interpretation of installables:\fR
.IP "\(bu" 2
\fC--derivation\fR
.br
Operate on the store derivation rather than its outputs.
.IP "\(bu" 2
\fC--expr\fR \fIexpr\fR
.br
Interpret installables as attribute paths relative to the Nix expression \fIexpr\fR.
.IP "\(bu" 2
\fC--file\fR / \fC-f\fR \fIfile\fR
.br
Interpret installables as attribute paths relative to the Nix expression stored in \fIfile\fR. If \fIfile\fR is the character -, then a Nix expression will be read from standard input.