<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/nix-index @ v0.1.5</title>
<meta name="description" content="README.md in fork/nix-index at v0.1.5.">
<meta property="og:title" content="README.md - fork/nix-index @ v0.1.5">
<meta property="og:description" content="README.md in fork/nix-index at v0.1.5.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v0.1.5" data-tip="1f8cbed09a8f055d6b28ab4867e156698b989499">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/nix-index</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/nix-index</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Benno Fünfstück</span><span class="commit-message" data-commit="36ff1aac466392fb2d7043fd3e196667a531374b">docs(README.md): feature nix-index-database</span><span class="snapshot-sha sha" data-commit="36ff1aac466392fb2d7043fd3e196667a531374b">36ff1aa</span><time datetime="2023-01-03T17:06:18+01:00" title="2023-01-03 17:06:18 +0100">2023-01-03</time></p>
<header class="topbar"><details class="switcher"><summary>v0.1.5</summary><div class="menu"><strong>branches</strong><a href="/fork/nix-index/ref/master/">master</a><strong>tags</strong><a href="/fork/nix-index/ref/v0.1.0/">v0.1.0</a><a href="/fork/nix-index/ref/v0.1.1/">v0.1.1</a><a href="/fork/nix-index/ref/v0.1.2/">v0.1.2</a><a href="/fork/nix-index/ref/v0.1.3/">v0.1.3</a><a href="/fork/nix-index/ref/v0.1.4/">v0.1.4</a><a class="current" href="/fork/nix-index/ref/v0.1.5/">v0.1.5</a><a href="/fork/nix-index/ref/v0.1.6/">v0.1.6</a><a href="/fork/nix-index/ref/v0.1.7/">v0.1.7</a><a class="all" href="/fork/nix-index/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/nix-index/">nix-index</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>4.6 KiB</span><span>98 lines</span></span><span class="actions"><a class="raw" href="/fork/nix-index/raw/fe1fc48bf0de27c9efe8dbb8aef5f01e541f895a/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>nix-index <a href="https://travis-ci.org/bennofs/nix-index"><img src="https://travis-ci.org/bennofs/nix-index.svg?branch=master" alt="Build Status" /></a></h1>
<h2>A files database for nixpkgs</h2>
<p><strong>nix-index</strong> is a tool to quickly locate the package providing a certain file in <a href="https://github.com/NixOS/nixpkgs"><code>nixpkgs</code></a>. It indexes built derivations found in binary caches.</p>
<h6>Demo</h6>
<pre>$ 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
</pre>
<h2>Installation</h2>
<h3>Flakes</h3>
<ol>
<li>
<p>create the database:</p>
<pre>$ nix run github:bennofs/nix-index#nix-index
</pre>
</li>
<li>
<p>query for a file:</p>
<pre>$ nix run github:bennofs/nix-index#nix-locate -- bin/hello
</pre>
</li>
</ol>
<h3>Latest Git version</h3>
<p>To install the latest development version of nix-index, simply clone the repo and run <code>nix-env -if.</code>:</p>
<pre>$ git clone https://github.com/bennofs/nix-index
$ cd nix-index
$ nix-env -if.
</pre>
<h3>Stable</h3>
<p>For the stable version, you can either <a href="https://git-scm.com/docs/git-checkout">checkout</a> the latest <a href="https://git-scm.com/docs/git-tag">tag</a> (see the list <a href="https://github.com/bennofs/nix-index/tags">here</a>) or use Nixpkgs' repositories' and install it with:</p>
<pre>$ nix-env -iA nixos.nix-index
</pre>
<h2>Usage</h2>
<p>First, you need to generate an index by running <code>nix-index</code> (it takes around 5 minutes) . Then, you can use <code>nix-locate pattern</code>. For more information, see <code>nix-locate --help</code> and <code>nix-index --help</code>.</p>
<h3>Use pre-generated database</h3>
<p><a href="https://github.com/Mic92/nix-index-database">nix-index-database</a> provides pre-generated databases if you don't want to generate a database locally.
It also comes with nixos/home-manager modules to use those databases.</p>
<h3>Usage as a command-not-found replacement</h3>
<p>Nix-index provides a "command-not-found" script that can print for you the attribute path of unfound commands in your shell. You can either source <code>${pkgs.nix-index}/etc/command-not-found.sh</code> in your own shell init files (works for ZSH and Bash for as far as we know) or you can use the following in home-manager / <code>/etc/nixos/configuration.nix</code>:</p>
<pre class="language-nix">    <a-v>programs</a-v><a-p>.</a-p><a-v>command-not-found</a-v><a-p>.</a-p><a-v>enable</a-v> <a-p>=</a-p> <a-v>false</a-v><a-p>;</a-p>
    <a-c># for home-manager, use programs.bash.initExtra instead</a-c>
    <a-v>programs</a-v><a-p>.</a-p><a-v>bash</a-v><a-p>.</a-p><a-v>interactiveShellInit</a-v> <a-p>=</a-p> <a-s>&#39;&#39;
      source </a-s><a-p>${</a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>nix-index</a-v><a-p>}</a-p><a-s>/etc/profile.d/command-not-found.sh
    &#39;&#39;</a-s><a-p>;</a-p></pre>
<p>Replace <code>bash</code> with <code>zsh</code> if you use <code>zsh</code>.</p>
<p>Example output:</p>
<pre>$ 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 ...
</pre>
<p>A <a href="https://nix-community.github.io/home-manager/options.html#opt-programs.nix-index.enable"><code>home-manager</code> module</a> is now available to integrate <code>nix-index</code> with <code>bash</code>, <code>zsh</code>, and <code>fish</code> using this script.</p>
<h2>Contributing</h2>
<p>If you find any missing features that you would like to implement, I'm very happy about any PRs! You can also create an issue first if the feature is more complex so we can discuss possible implementations.</p>
<p>Here is a quick description of all relevant files:</p>
<ul>
<li><code>bin/{nix-index, nix-locate}.rs</code>: Implementation of the nix-index / nix-locate command line tools</li>
<li><code>src/database.rs</code>: High-level functions for working with the database format</li>
<li><code>src/files.rs</code>: The data types for working with file listings</li>
<li><code>src/frcode.rs</code>: Low-level implementation of an encoder to efficiently store many file paths (see comments in the file for more details). Used by <code>database.rs</code>.</li>
<li><code>src/hydra.rs</code>: Deals with everything that has to do with downloading from the binary cache (fetching file listings and references)</li>
<li><code>src/nixpkgs.rs</code>: Implements the gathering of the packages (store paths and attributes) using <code>nix-env</code></li>
<li><code>src/package.rs</code>: High-level data types for representing store paths (sometimes also refered to as a package)</li>
<li><code>src/workset.rs</code>: A queue used by <code>nix-index</code> to implement the recursive fetching (fetching references of everything)</li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>nix-index [![Build Status](https://travis-ci.org/bennofs/nix-index.svg?branch=master)](https://travis-ci.org/bennofs/nix-index)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>##</a-p> <a-tt>A files database for nixpkgs</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">**nix-index** is a tool to quickly locate the package providing a certain file in [`nixpkgs`](https://github.com/NixOS/nixpkgs). It indexes built derivations found in binary caches. </span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>######</a-p> <a-tt>Demo</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>$ nix-locate &#39;bin/hello&#39;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>hello.out                                        29,488 x /nix/store/bdjyhh70npndlq3rzmggh4f2dzdsj4xy-hello-2.10/bin/hello</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>linuxPackages_4_4.dpdk.examples               2,022,224 x /nix/store/jlnk3d38zsk0bp02rp9skpqk4vjfijnn-dpdk-16.07.2-4.4.52-examples/bin/helloworld</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>linuxPackages.dpdk.examples                   2,022,224 x /nix/store/rzx4k0pb58gd1dr9kzwam3vk9r8bfyv1-dpdk-16.07.2-4.9.13-examples/bin/helloworld</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>linuxPackages_4_10.dpdk.examples              2,022,224 x /nix/store/wya1b0910qidfc9v3i6r9rnbnc9ykkwq-dpdk-16.07.2-4.10.1-examples/bin/helloworld</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>linuxPackages_grsec_nixos.dpdk.examples       2,022,224 x /nix/store/2wqv94290pa38aclld7sc548a7hnz35k-dpdk-16.07.2-4.9.13-examples/bin/helloworld</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>camlistore.out                                7,938,952 x /nix/store/xn5ivjdyslxldhm5cb4x0lfz48zf21rl-camlistore-0.9/bin/hello</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>## </a-p><a-tt>Installation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>### </a-p><a-tt>Flakes</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>1. create the database:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>   </a-p><a-tl>```</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>   </a-p><a-tl>$ nix run github:bennofs/nix-index#nix-index</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>   ```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>2. query for a file:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>   </a-p><a-tl>```</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>   </a-p><a-tl>$ nix run github:bennofs/nix-index#nix-locate -- bin/hello</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>   ```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>### </a-p><a-tt>Latest Git version</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>To install the latest development version of nix-index, simply clone the repo and run `nix-env -if.`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>$ git clone https://github.com/bennofs/nix-index</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>$ cd nix-index</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>$ nix-env -if.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>### </a-p><a-tt>Stable</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>For the stable version, you can either [checkout](https://git-scm.com/docs/git-checkout) the latest [tag](https://git-scm.com/docs/git-tag) (see the list [here](https://github.com/bennofs/nix-index/tags)) or use Nixpkgs&#39; repositories&#39; and install it with:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>$ nix-env -iA nixos.nix-index</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>## </a-p><a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>First, you need to generate an index by running `nix-index` (it takes around 5 minutes) . Then, you can use `nix-locate pattern`. For more information, see `nix-locate --help` and `nix-index --help`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>### </a-p><a-tt>Use pre-generated database</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>[nix-index-database](https://github.com/Mic92/nix-index-database) provides pre-generated databases if you don&#39;t want to generate a database locally.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>It also comes with nixos/home-manager modules to use those databases.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>### </a-p><a-tt>Usage as a command-not-found replacement</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>Nix-index provides a &quot;command-not-found&quot; script that can print for you the attribute path of unfound commands in your shell. You can either source `${pkgs.nix-index}/etc/command-not-found.sh` in your own shell init files (works for ZSH and Bash for as far as we know) or you can use the following in home-manager / `/etc/nixos/configuration.nix`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>```</a-p><a-tl>nix</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    </a-p><a-v>programs</a-v><a-p>.</a-p><a-v>command-not-found</a-v><a-p>.</a-p><a-v>enable</a-v><a-p> = </a-p><a-v>false</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>    </a-p><a-c># for home-manager, use programs.bash.initExtra instead</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    </a-p><a-v>programs</a-v><a-p>.</a-p><a-v>bash</a-v><a-p>.</a-p><a-v>interactiveShellInit</a-v><a-p> = </a-p><a-s>&#39;&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>      source ${</a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>nix-index</a-v><a-p>}/etc/profile.d/command-not-found.sh</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>    &#39;&#39;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>Replace `bash` with `zsh` if you use `zsh`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>Example output:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>$ blender</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>The program &#39;blender&#39; is currently not installed. You can install it</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>by typing:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>  nix-env -iA nixpkgs.blender.out</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>Or run it once with:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>  nix-shell -p blender.out --run ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>A [`home-manager` module](https://nix-community.github.io/home-manager/options.html#opt-programs.nix-index.enable) is now available to integrate `nix-index` with `bash`, `zsh`, and `fish` using this script.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>## </a-p><a-tt>Contributing</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>If you find any missing features that you would like to implement, I&#39;m very happy about any PRs! You can also create an issue first if the feature is more complex so we can discuss possible implementations.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>Here is a quick description of all relevant files:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>* `bin/{nix-index, nix-locate}.rs`: Implementation of the nix-index / nix-locate command line tools</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>* `src/database.rs`: High-level functions for working with the database format</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>* `src/files.rs`: The data types for working with file listings</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>* `src/frcode.rs`: Low-level implementation of an encoder to efficiently store many file paths (see comments in the file for more details). Used by `database.rs`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>* `src/hydra.rs`: Deals with everything that has to do with downloading from the binary cache (fetching file listings and references)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>* `src/nixpkgs.rs`: Implements the gathering of the packages (store paths and attributes) using `nix-env`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>* `src/package.rs`: High-level data types for representing store paths (sometimes also refered to as a package)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>* </a-p>`src/workset.rs`: A queue used by `nix-index` to implement the recursive fetching (fetching references of everything)</span></span></pre></div></div>
</main>
</body>
</html>
