2 个版本

0.1.7 2023 年 8 月 24 日
0.1.6 2023 年 6 月 2 日

239操作系统

每月 21 次下载

BSD-3-Clause 协议

155KB
2.5K SLoC

nix-index

nixpkgs 的文件数据库

nix-index 是一个工具,用于快速定位在 nixpkgs 中提供特定文件的包。它索引二进制缓存中找到的构建派生项。

演示
$ nix-locate 'bin/hello'
hello.out                                        29,488 x /nix/store/bdjyhh70npndlq3rzmggh4f2dzdsj4xy-hello-2.10/bin/hello
linuxPackages_4_4.dpdk.examples               2,022,224 x /nix/store/jlnk3d38zsk0bp02rp9skpqk4vjfijnn-dpdk-16.07.2-4.4.52-examples/bin/helloworld
linuxPackages.dpdk.examples                   2,022,224 x /nix/store/rzx4k0pb58gd1dr9kzwam3vk9r8bfyv1-dpdk-16.07.2-4.9.13-examples/bin/helloworld
linuxPackages_4_10.dpdk.examples              2,022,224 x /nix/store/wya1b0910qidfc9v3i6r9rnbnc9ykkwq-dpdk-16.07.2-4.10.1-examples/bin/helloworld
linuxPackages_grsec_nixos.dpdk.examples       2,022,224 x /nix/store/2wqv94290pa38aclld7sc548a7hnz35k-dpdk-16.07.2-4.9.13-examples/bin/helloworld
camlistore.out                                7,938,952 x /nix/store/xn5ivjdyslxldhm5cb4x0lfz48zf21rl-camlistore-0.9/bin/hello

安装

Flakes

  1. 创建数据库

    $ nix run github:nix-community/nix-index#nix-index
    
  2. 查询文件

    $ nix run github:nix-community/nix-index#nix-locate -- bin/hello
    

最新 Git 版本

要安装 nix-index 的最新开发版本,只需克隆仓库并运行 nix-env -if.

$ git clone https://github.com/nix-community/nix-index
$ cd nix-index
$ nix-env -if.

稳定版

对于稳定版本,您可以要么 检出 最新的 标签(请参阅此处的列表)或使用 Nixpkgs 仓库并使用以下命令安装:

$ nix-env -iA nixos.nix-index

用法

首先,您需要运行 nix-index 生成索引(大约需要 5 分钟)。然后,您可以使用 nix-locate pattern。有关更多信息,请参阅 nix-locate ---helpnix-index ---help

使用预生成的数据库

nix-index-database 提供预生成的数据库,如果您不想本地生成数据库。它还附带 nixos/home-manager 模块以使用这些数据库。

作为命令未找到的替代方案使用

Nix-index 提供了一个 "命令未找到" 脚本,该脚本可以为您打印出 shell 中未找到的命令的属性路径。您可以在自己的 shell 初始化文件中 ${pkgs.nix-index}/etc/command-not-found.sh 中源码(我们知道 ZSH 和 Bash 都适用)或使用以下在 home-manager / /etc/nixos/configuration.nix 中:

    programs.command-not-found.enable = false;
    # for home-manager, use programs.bash.initExtra instead
    programs.bash.interactiveShellInit = ''
      source ${pkgs.nix-index}/etc/profile.d/command-not-found.sh
    '';

如果您使用的是 zsh,请将 bash 替换为 zsh

示例输出

$ blender
The program 'blender' is currently not installed. You can install it
by typing:
  nix-env -iA nixpkgs.blender.out

Or run it once with:
  nix-shell -p blender.out --run ...

现在有一个home-manager模块,可以整合nix-indexbashzshfish,使用此脚本即可。

贡献

如果您发现缺少的功能并希望实现,我将非常欢迎任何PR!如果功能更复杂,您也可以先创建一个问题,这样我们可以讨论可能的实现方式。

以下是所有相关文件的简要描述

  • bin/{nix-index, nix-locate}.rs:nix-index / nix-locate命令行工具的实现
  • src/database.rs:用于处理数据库格式的高级函数
  • src/files.rs:用于处理文件列表的数据类型
  • src/frcode.rs:高效存储许多文件路径的编码器的低级实现(有关更多详细信息,请参阅文件中的注释)。由database.rs使用。
  • src/hydra.rs:处理与从二进制缓存下载相关的一切(获取文件列表和引用)
  • src/nixpkgs.rs:使用nix-env实现收集包(存储路径和属性)
  • src/package.rs:表示存储路径(有时也称为包)的高级数据类型
  • src/workset.rs:由nix-index使用的队列,用于实现递归获取(获取所有内容的引用)

依赖

~61MB
~1M SLoC