https://github.com/3timeslazy/nix-search-tv
Fuzzy search for Nix packages.
https://github.com/3timeslazy/nix-search-tv
cli fzf nix nixos search television
Last synced: 7 days ago
JSON representation
Fuzzy search for Nix packages.
- Host: GitHub
- URL: https://github.com/3timeslazy/nix-search-tv
- Owner: 3timeslazy
- License: gpl-3.0
- Created: 2025-01-29T09:30:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T18:35:28.000Z (19 days ago)
- Last Synced: 2025-04-13T00:53:10.027Z (7 days ago)
- Topics: cli, fzf, nix, nixos, search, television
- Language: Go
- Homepage:
- Size: 9.86 MB
- Stars: 49
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nix - nix-search-tv - CLI fuzzy finder for packages and options from Nixpkgs, Home Manager, and more. (Resources / Discovery)
README
# nix-search-tv
Fuzzy search for NixOS packages.
---
[](https://asciinema.org/a/afNYMXrhoEwwh3wzOK7FbsFtW)
## Installation
### Nix Package
```nix
environment.systemPackages = [ nix-search-tv ]
```
### Flake
There are many ways how one can install a package from a flake, below is one:
```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
nix-search-tv.url = "github:3timeslazy/nix-search-tv";
};
outputs = {
nixpkgs,
nix-search-tv,
...
}: {
nixosConfigurations.system = nixpkgs.lib.nixosSystem {
modules = [
{
environment.systemPackages = [
nix-search-tv.packages.x86_64-linux.default
];
}
];
};
};
}
```
### Go
```sh
git clone https://github.com/3timeslazy/nix-search-tv
cd nix-search-tv
go install ./cmd/nix-search-tv
# `go install github.com/3timeslazy/nix-search-tv/cmd/nix-search-tv@latest` won't work
# because go.mod contains a replace directive
```
## Usage
`nix-search-tv` does not do the search by itself, but rather integrates
with other general purpose fuzzy finders, such as [television](https://github.com/alexpasmantier/television) and [fzf](https://github.com/junegunn/fzf)
### Television
Add `nix_channels.toml` file to your television config directory with the content below:
```toml
[[cable_channel]]
name = "nixpkgs"
source_command = "nix-search-tv print"
preview_command = "nix-search-tv preview {}"
```
### fzf
The most straightforward integration might look like:
```sh
alias ns="nix-search-tv print | fzf --preview 'nix-search-tv preview {}' --scheme history"
```
> [!NOTE]
> No matter how you use nix-search-tv with fzf, it's better to add `--scheme history`. That way, the options will be sorted, which makes the search experience better
More advanced integration might be found here in [nixpkgs.sh](./nixpkgs.sh). It is the same search but with the following shortcuts:
- Search only Nixpkgs or Home Manager
- Open package code declaration or homepage
- Search GitHub for snippets with the selected package/option
You can install it like:
```sh
let
ns = pkgs.writeShellScriptBin "ns" (builtins.readFile ./path/to/nixpkgs.sh);
in {
environment.systemPackages = [ ns ]
}
```
## Configuration
By default, the configuration file is looked at `$XDG_CONFIG_HOME/nix-search-tv/config.json`
```jsonc
{
// What indexes to search by default
//
// default:
// linux: [nixpkgs, "home-manager", "nur", "nixos"]
// darwin: [nixpkgs, "home-manager", "nur", "darwin"]
"indexes": ["nixpkgs", "home-manager", "nur"],
// How often to look for updates and run
// indexer again
//
// default: 1 week (168h)
"update_interval": "3h2m1s",
// Where to store the index files
//
// default: $XDG_CACHE_HOME/nix-search-tv
"cache_dir": "path/to/cache/dir",
// Whether to show the banner when waiting for
// the indexing
//
// default: true
"enable_waiting_message": true,
}
```
## Searchable package registries
- [Nixpkgs](https://search.nixos.org/packages?channel=unstable)
- [Home Manager](https://github.com/nix-community/home-manager)
- [NixOS](https://search.nixos.org/options)
- [Darwin](https://github.com/LnL7/nix-darwin)
- [NUR](https://github.com/nix-community/NUR)
## Credits
This project was inspired and wouldn't exist without work done by [nix-search](https://github.com/diamondburned/nix-search) contributors.