nix-tree/README.md

61 lines
1.6 KiB
Markdown
Raw Normal View History

2020-07-02 11:55:56 +03:00
# nix-tree
2020-06-25 01:47:16 +03:00
2020-07-02 12:12:51 +03:00
![Build Status](https://github.com/utdemir/nix-tree/workflows/nix-build/badge.svg)
[![Packaging status](https://repology.org/badge/vertical-allrepos/nix-tree.svg)](https://repology.org/project/nix-tree/versions)
2020-07-02 12:12:51 +03:00
2020-06-29 13:56:15 +03:00
Interactively browse the dependency graph of your Nix derivations.
2020-06-29 13:53:45 +03:00
2020-07-02 11:55:56 +03:00
[![asciicast](https://asciinema.org/a/ahDveBL1gs5t36z1myePtrKpR.svg)](https://asciinema.org/a/ahDveBL1gs5t36z1myePtrKpR)
2020-06-29 13:53:45 +03:00
## Installation
From nixpkgs-unstable:
```
nix-env -iA nix-tree -f https://github.com/nixos/nixpkgs/archive/nixpkgs-unstable.tar.gz
```
Development version:
2020-06-29 13:53:45 +03:00
```
2020-07-02 11:55:56 +03:00
nix-env -iA nix-tree -f https://github.com/utdemir/nix-tree/archive/master.tar.gz
2020-07-02 00:24:45 +03:00
```
A nixpkgs overlay is also provided via `overlay.nix`, that can be used
with tools like [home-manager][]:
```nix
nixpkgs.overlays = [
2020-07-02 11:55:56 +03:00
(let url = https://github.com/utdemir/nix-tree/archive/master.tar.gz;
2020-07-02 00:24:45 +03:00
in import "${builtins.fetchTarball url}/overlay.nix" {})
];
2020-07-02 11:55:56 +03:00
home.packages = [ pkgs.nix-tree ];
2020-06-29 13:53:45 +03:00
```
2020-06-29 13:53:45 +03:00
## Usage
2020-06-25 01:47:16 +03:00
```
2020-07-02 11:55:56 +03:00
$ nix-tree --help
nix-tree --help
Usage: nix-tree [paths] [-h|--help]
2020-07-01 09:34:37 +03:00
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
i : Toggle modeline
? : Show help
2020-06-25 01:47:16 +03:00
```
2020-07-02 00:24:45 +03:00
[home-manager]: https://github.com/rycee/home-manager
2020-07-02 10:55:36 +03:00
# Related tools
* [nix-du](https://github.com/symphorien/nix-du)
2020-07-02 11:55:56 +03:00
* [nix-query-tree-viewer](https://github.com/cdepillabout/nix-query-tree-viewer)
* [nix-visualize](https://github.com/craigmbooth/nix-visualize)