Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utdemir/nix-tree
Interactively browse dependency graphs of Nix derivations.
https://github.com/utdemir/nix-tree
dependency-graph hacktoberfest nix
Last synced: 29 days ago
JSON representation
Interactively browse dependency graphs of Nix derivations.
- Host: GitHub
- URL: https://github.com/utdemir/nix-tree
- Owner: utdemir
- License: bsd-3-clause
- Created: 2020-06-24T22:41:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T00:24:15.000Z (6 months ago)
- Last Synced: 2024-05-02T05:10:22.218Z (6 months ago)
- Topics: dependency-graph, hacktoberfest, nix
- Language: Haskell
- Homepage:
- Size: 244 KB
- Stars: 616
- Watchers: 7
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nix - nix-tree - Interactively browse the dependency graph of Nix derivations. (Command-Line Tools / Discovery)
README
# nix-tree
[](https://repology.org/project/haskell:nix-tree/versions)
Interactively browse dependency graphs of Nix derivations.
[](https://asciinema.org/a/cnilbmPXW51g97hdNJZcM5F6h)
## Installation
`nix-tree` is on `nixpkgs` since `20.09`, so just use your preferred method for adding packages to your system, eg:
```
nix-env -iA nix-tree
```
Or, for flake enabled systems:
```
nix profile install 'nixpkgs#nix-tree'
```
To run the current development version:
```
nix run github:utdemir/nix-tree -- --help
```
## Usage
```console
$ nix-tree --help
Usage: nix-tree [INSTALLABLE] [--store STORE] [--file FILE] [--version] [--derivation] [--impure] [--dot]
Interactively browse dependency graphs of Nix derivations.
Available options:
INSTALLABLE A store path or a flake reference.
Paths default to "~/.nix-profile" and "/var/run/current-system"
--store STORE The URL of the Nix store, e.g. "daemon" or "https://cache.nixos.org"
See "nix help-stores" for supported store types and settings.
--file FILE Interpret installables as attribute paths relative to the Nix expression stored in file.
--version Show the nix-tree version
--derivation Operate on the store derivation rather than its outputs
--impure Allow access to mutable paths and repositories
--dot Print the dependency graph in dot format
-h,--help Show this help text
Keybindings:
hjkl/Arrow Keys : Navigate
w : Open why-depends modal
/ : Open search modal
s : Change sort order
y : Yank selected path to clipboard
? : Show help
q/Esc : Quit / close modal
```
### 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 . | xargs -o nix-tree --derivation
# Dependencies from shell.nix
nix-build shell.nix -A inputDerivation | xargs -o nix-tree
# All outputs of a derivation in nixpkgs
nix-build '' -A openssl.all --no-out-link | xargs -o nix-tree
```
`nix-tree` also supports flake references:
```bash
# Build time dependencies of a flake on the current directory
nix-tree --derivation '.#'
# Same thing works for any flake reference
nix-tree --derivation 'nixpkgs#asciiquarium'
```
Run `nix-tree` on your current nixos system:
```bash
nix-tree /nix/var/nix/profiles/system
```
Run `nix-tree` on a flake reference of a nixosConfiguration:
```bash
nix build --print-out-paths --no-link '.#nixosConfigurations.foo.config.system.build.toplevel'
nix-tree '.#nixosConfigurations.foo.config.system.build.toplevel'
```
Query the binary cache before download, with the `--store` option:
```bash
# Query the runtime dependency of `stellarium` (2 GiB closure) without download
nix eval --raw 'nixpkgs#stellarium.outPath' | xargs -o nix-tree --store https://cache.nixos.org
```
For valid `--store` options, see [`nix help-stores`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-help-stores). For example,
```bash
# Build in a temporary chroot store and examine the output
nix build --store /tmp/chroot-store 'nixpkgs#hello' --print-out-paths | xargs -o nix-tree --store /tmp/chroot-store
```
## Contributing
All contributions, issues and feature requests are welcome.
To hack on it, simply run `nix-shell` and use `cabal` as usual. Please run `./format.sh` before sending a PR.
## Related tools
* [nix-du](https://github.com/symphorien/nix-du): Visualise which gc-roots to delete to free some space in your nix store
* [nix-melt](https://github.com/nix-community/nix-melt): A ranger-like flake.lock viewer
* [nix-query-tree-viewer](https://github.com/cdepillabout/nix-query-tree-viewer): GTK viewer for the output of `nix-store --query --tree`
* [nix-visualize](https://github.com/craigmbooth/nix-visualize): Uses the Nix package manager to visualize the dependencies of a given package