zebreus/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests 1 Activity
lix/src/nix/search.md
Qyriad 194ba8a02f docs: guide to installables docs in installable commands' docs 
The installables syntax is not documented in any of the man pages or
docbook pages for any of those individual commands. And while these
commands really should at least peripherally individually document how
installables work, in the meantime we can at least direct people to the
right place.

This commit also clarifies the unexpected fact that `nix profile remove`
and `nix profile upgrade` do *not* take installables.

Change-Id: I3b1453cb197a613bbab639c66a466365c3592c6d
2024-04-29 08:06:05 -06:00

2.7 KiB
Raw Blame History

R""(

Note: this command's interface is based heavily around installables, which you may want to read about first (nix --help).

Examples

  • Show all packages in the nixpkgs flake:

    # 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
…

  • Show packages in the nixpkgs flake containing blender in its name or description:

    # nix search nixpkgs blender
* legacyPackages.x86_64-linux.blender (2.91.0)
  3D Creation/Animation/Publishing System

  • Search for packages underneath the attribute gnome3 in Nixpkgs:

    # nix search nixpkgs#gnome3 vala
* legacyPackages.x86_64-linux.gnome3.vala (0.48.9)
  Compiler for GObject type system

  • Show all packages in the flake in the current directory:

    # nix search . ^

  • Search for Firefox or Chromium:

    # nix search nixpkgs 'firefox|chromium'

  • Search for packages containing git and either frontend or gui:

    # nix search nixpkgs git 'frontend|gui'

  • Search for packages containing neovim but hide ones containing either gui or python:

    # nix search nixpkgs neovim --exclude 'python|gui'

    or

    # nix search nixpkgs neovim --exclude 'python' --exclude 'gui'

Description

nix search searches installable (which can be evaluated, that is, a flake or Nix expression, but not a store path or store derivation path) for packages whose name or description matches all of the regular expressions regex. For each matching package, It prints the full attribute name (from the root of the installable), the version and the meta.description field, highlighting the substrings that were matched by the regular expressions.

To show all packages, use the regular expression ^. In contrast to .*, it avoids highlighting the entire name and description of every package.

Note that in this context, ^ is the regex character to match the beginning of a string, not the delimiter for selecting a derivation output.

Flake output attributes

If no flake output attribute is given, nix search searches for packages:

  • Directly underneath packages.<system>.

  • Underneath legacyPackages.<system>, recursing into attribute sets that contain an attribute recurseForDerivations = true.

)""