mirror of
https://github.com/utdemir/nix-tree.git
synced 2024-09-17 18:07:34 +03:00
80 lines
2.2 KiB
Markdown
80 lines
2.2 KiB
Markdown
# nix-tree
|
|
|
|
|
|
[](https://repology.org/project/haskell:nix-tree/versions)
|
|
|
|
Interactively browse the dependency graph of your Nix derivations.
|
|
|
|
[](https://asciinema.org/a/ahDveBL1gs5t36z1myePtrKpR)
|
|
|
|
## Installation
|
|
|
|
Stable version:
|
|
|
|
```
|
|
nix-env -i nix-tree
|
|
```
|
|
|
|
Development version (requires Nix with flake support):
|
|
|
|
```
|
|
nix profile install github:utdemir/nix-tree
|
|
```
|
|
|
|
## Usage
|
|
|
|
```
|
|
$ nix-tree --help
|
|
nix-tree --help
|
|
Usage: nix-tree [paths] [-h|--help]
|
|
Paths default to $HOME/.nix-profile and /var/run/current-system.
|
|
Keybindings:
|
|
hjkl/Arrow Keys : Navigate
|
|
q/Esc: : Quit / close modal
|
|
w : Open why-depends mode
|
|
/ : Open search mode
|
|
s : Change sort order
|
|
? : Show help
|
|
```
|
|
|
|
### Glossary
|
|
|
|
* **NAR Size**: Size of the store path itself.
|
|
* **Closure size**: Total size of the store path and all its transitive dependencies.
|
|
* **Added size**: Size of the store path, and all its _unique_ transitive
|
|
dependencies. In other words, the cost of having that store path on top
|
|
of all other paths. See [issue #14] for a better explanation.
|
|
|
|
[issue #14]: https://github.com/utdemir/nix-tree/issues/14
|
|
|
|
### Tips
|
|
|
|
`nix-build` prints built paths to stdout, which can be piped conveniently
|
|
with `| xargs -o nix-tree`. Examples:
|
|
|
|
```bash
|
|
# Output of a local derivation
|
|
nix-build . --no-out-link | xargs -o nix-tree
|
|
|
|
# Build time dependencies (passing a `.drv` path)
|
|
nix-instantiate --no-out-link | xargs -o nix-tree
|
|
|
|
# Dependencies from shell.nix
|
|
nix-build shell.nix -A inputDerivation | xargs -o nix-tree
|
|
|
|
# All outputs of a derivation in nixpkgs:
|
|
nix-build '<nixpkgs>' -A openssl.all --no-out-link | xargs -o nix-tree
|
|
```
|
|
|
|
## Hacking
|
|
|
|
All contributions, issues and feature requests are welcome.
|
|
|
|
To hack on it, simply run `nix-shell` (or `nix develop`) and use `cabal` as usual.
|
|
|
|
# Related tools
|
|
|
|
* [nix-du](https://github.com/symphorien/nix-du)
|
|
* [nix-query-tree-viewer](https://github.com/cdepillabout/nix-query-tree-viewer)
|
|
* [nix-visualize](https://github.com/craigmbooth/nix-visualize)
|