Jump to content

Searching packages

From Official NixOS Wiki

There are numerous approaches available for searching substrings within both package names and package descriptions in nixpkgs.

Using search.nixos.org website

There is a web service to search with

channel branches
flakes
pros
  • easy to use
  • allows filters
  • nice GUI in browser
  • browser extensions possible (like @nixpkgs as search engine in Firefox)
cons
  • always requires Internet connection


If you'd like to search with this web service from the command line, you may use peterldowns/nix-search-cli. It provides exactly the same search experience by default.

Other online sites for searching

These are another possible places to search

  • github.com - search for regex/strings in nixpkgs, home-manager, nix-darwin and any other public github repos.
  • mynixos.com - search for packages in nixpkgs, also nixos, home-manager, nix-darwin options. Not foss and unofficial.
  • home-manager-options.extranix.com - search for home-manager options. foss

Using the nix search command

While this command requires flakes, you can use it to search for a package. It may be slow the first time, but further runs will use cached results. 

nix search nixpkgs firefox
pros
  • fast
  • possible offline usage
cons
  • requires disk space for caching
  • quite long command


There are third party tools that allow searching for packages similarly to nix search, namely:

  • diamondburned/nix-search: A faster and channel-compatible nix search using only stable Nix tools (no flakes required) which creates a local database with a package index.

Using the nix-env command

It's possible to search for a package using nix-env -qaP

pros
  • works offline
cons
  • it's very slow and requires a lot of memory

Using the nps command

nps caches entire nix search nixpkgs ^ and nix-env -qaP --description results locally and queries the cache. 

nps firefox
pros
  • works offline
  • very fast
  • easy syntax
  • output sorted by relevance
cons

Using the nix repl environment

With the read–eval–print loop (REPL) of nix you can browse packages interactively.

Starting the nix repl 

nix repl

Welcome to Nix 2.18.2. Type :? for help.

nix-repl>

Loading the repository for nixpkgs 

nix-repl>

nix-repl> :load <nixpkgs>
Added 21181 variables.

Type the first letters of a package 

nix-repl> neo

Press Tab ↹ key for auto completion

Reverse search: searching which package provides a file

There are third party programs that make it easier to determine which package you need to install in order to obtain a specific file or program.

These are most commonly used, and require you to create an index on your computer before you can search for a package:

These are online tools which search an index someone else keeps up to date:

Retrieved from "https://wiki.nixos.org/w/index.php?title=Searching_packages&oldid=28872"