utdemir/nix-tree
1
1
Fork 0
mirror of https://github.com/utdemir/nix-tree.git synced 2024-10-05 18:58:59 +03:00
Code Issues Projects Releases Wiki Activity
Interactively browse dependency graphs of Nix derivations.
165 Commits 8 Branches 18 Tags 428 KiB
Haskell 93.5%
Nix 3.8%
Shell 2.7%
4eaca0c0bd
Go to file
Utku Demir 4eaca0c0bd Fix a nonexhaustive pattern match
2023-01-14 17:43:09 +13:00
.github/workflows ci: Reduce the frequency of automatic dependency updates 2022-11-26 13:37:01 +13:00
src Fix a nonexhaustive pattern match 2023-01-14 17:43:09 +13:00
test Delete duplicate file 2021-09-04 22:23:12 +12:00
.gitignore Stop using flakes 2021-05-05 23:51:34 +12:00
asciicast.sh Update asciicast 2021-02-28 00:12:41 +13:00
CHANGELOG.md Release v0.3.1 2022-12-10 11:38:27 +03:00
default.nix Move to a flake-based setup 2022-10-24 11:52:14 +13:00
flake.lock flake.lock: Update 2023-01-04 14:18:22 +13:00
flake.nix Remove now-unnecessary brick overrides 2023-01-04 14:18:22 +13:00
format.sh ci: Do not try to format absent file 2022-11-07 15:15:05 +13:00
LICENSE Add LICENSE 2020-12-22 10:52:02 +13:00
nix-tree.cabal Release v0.3.1 2022-12-10 11:38:27 +03:00
README.md Small README updates 2022-11-26 12:17:54 +13:00
shell.nix Revert "Remove shell.nix, use 'nix develop' instead" 2022-12-04 22:56:45 +08:00

README.md

nix-tree

Build Status Packaging status

Interactively browse dependency graphs of Nix derivations.

asciicast

Installation

nix-tree is on nixpkgs since 20.09, so just use your preferred method for adding packages to your system, eg:

nix-env -i nix-tree

To run the current development version:

nix run github:utdemir/nix-tree -- --help

Usage

$ nix-tree --help
Usage: nix-tree [--version] [--derivation] [INSTALLABLE]
  Interactively browse dependency graphs of Nix derivations.

Available options:
  --version                Show the nix-tree version.
  --derivation             Operate on the store derivation rather than its
                           outputs.
  INSTALLABLE              A store path or a flake reference. Paths default to
                           "~/.nix-profile" and "/var/run/current-system".
  -h,--help                Show this help text

Keybindings:
  hjkl/Arrow Keys : Navigate
  w               : Open why-depends mode
  /               : Open search mode
  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.

Tips

nix-build prints built paths to stdout, which can be piped conveniently with | xargs -o nix-tree. Examples:

# Output of a local derivation
nix-build . --no-out-link | xargs -o nix-tree

# Build time dependencies (passing a `.drv` path)
nix-instantiate -r | 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 '<nixpkgs>' -A openssl.all --no-out-link | xargs -o nix-tree

nix-tree also supports flake references:

# 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'

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