LinuxCommandLibrary

nix-search

Search for Nix packages

TLDR

Search nixpkgs for a package based on its name or description

$ nix search [nixpkgs] [search_term]
copy

Show description of a package from nixpkgs
$ nix search [nixpkgs#pkg]
copy

Show all packages available from a flake on github
$ nix search [github:owner/repo]
copy

SYNOPSIS

nix-search [options]

PARAMETERS


    The search term. Can be a package name, description, or attribute path.

--json
    Output the results in JSON format.

-f, --file
    The Nix expression to search. Defaults to Nixpkgs.

DESCRIPTION

The `nix-search` command allows users to search for Nix packages and NixOS options within available Nix channels or specific package sets. It provides a way to discover packages and configuration options by name, description, or attribute path. `nix-search` utilizes the Nix Package Manager's capabilities to query metadata about available packages and options, making it easier to find and understand available software within the Nix ecosystem. The command is particularly useful for exploring the vast collection of packages and configuration options available in Nixpkgs, enabling users to easily identify and incorporate specific software or configurations into their Nix-based systems.

CAVEATS

The output format and search results may vary depending on the Nixpkgs version or channel being used. Be mindful when relying on the output for scripting since attributes are not stable.

EXAMPLES

Searching for a package:
nix-search firefox

Searching for a package and outputting in JSON format:
nix-search --json firefox

Searching within a specific Nix expression:
nix-search -f '' firefox
(use to reference the default channel).
Note: Using -f argument it is possible to specify custom nix expression to search in. Be careful about the syntax.

SEE ALSO

nix-env(1), nix-build(1), nix(1)

Copied to clipboard