A modern, multi-threaded file-tree visualization and disk usage analysis tool that respects hidden file and .gitignore i.e. the secret love child of tree and du.
- Description
- Usage
- Installation
- Info
- Comparisons against similar programs
- Rules for Contributing and Feature Requests
- Special Thanks
- Questions you might have
erdtree is a modern alternative to tree and du in that it:
- offers a minimal and user-friendly CLI
- respects hidden files and
.gitignorerules by default - displays file sizes in human-readable format by default
- leverages parallism to traverse the file-system
- displays files using ANSI colors by default
- supports icons! (checkout the Icons section before using)
If the chosen defaults don't meet your requirements and you don't want to bloat your shell configs with aliases, you can use a configuration file instead.
erdtree (et) is a multi-threaded filetree visualizer and disk usage analyzer.
Usage: et [OPTIONS] [DIR]
Arguments:
[DIR] Root directory to traverse; defaults to current working directory
Options:
-c, --count Include aggregate file count in tree output
-d, --disk-usage <DISK_USAGE> Print physical or logical file size [default: logical] [possible values: logical, physical]
-g, --glob <GLOB> Include or exclude files using glob patterns
--iglob <IGLOB> Include or exclude files using glob patterns; case insensitive
--glob-case-insensitive Process all glob patterns case insensitively
-H, --hidden Show hidden files
--ignore-git Disable traversal of .git directory when traversing hidden files; disabled by default
-I, --icons Display file icons
-i, --ignore-git-ignore Ignore .gitignore
-l, --level <NUM> Maximum depth to display
-n, --scale <NUM> Total number of digits after the decimal to display for disk usage [default: 2]
-p, --prefix <PREFIX> Display disk usage as binary or SI units [default: bin] [possible values: bin, si]
-P, --prune Disable printing of empty branches
-r, --report Print disk usage information in plain format without ASCII tree
--human Print human-readable disk usage in report
--file-name Print file-name in report as opposed to full path
-s, --sort <SORT> Sort-order to display directory content [default: none] [possible values: name, size, size-rev, none]
--dirs-first Always sorts directories above files
-S, --follow-links Traverse symlink directories and consider their disk usage
-t, --threads <THREADS> Number of threads to use [default: 3]
--completions <COMPLETIONS> Print completions for a given shell to stdout [possible values: bash, elvish, fish, powershell, zsh]
--dirs-only Only print directories
--suppress-size Omit disk usage from output
--size-left Show the size on the left, decimal aligned
--no-config Don't read configuration file
-h, --help Print help (see more with '--help')
-V, --version Print version
Make sure you have Rust and its toolchain installed.
$ cargo install erdtree
$ brew install erdtree
$ scoop install erdtree
$ pkgin install erdtree
Binaries for common architectures can be downloaded from latest releases.
If you'd like the latest features that are on master but aren't yet included as part of a release:
$ cargo install --git https://github.com/solidiquis/erdtree --branch master
Other means of installation to come.
If erdtree's out-of-the-box defaults don't meet your specific requirements, you can set your own defaults using a configuration file.
erdtree will look for a configuration file in any of these locations:
$ERDTREE_CONFIG_PATH$XDG_CONFIG_HOME/erdtree/.erdtreerc$XDG_CONFIG_HOME/.erdtreerc$HOME/.config/erdtree/.erdtreerc$HOME/.erdtreerc
The format of a config file is as follows:
- Every line is an
erdtreeoption/argument. - Lines starting with
#are considered comments and are thus ignored.
Arguments passed to erdtree take precedence. If you have a config that you would like to ignore without deleting you can use --no-config.
Here is an example of a valid config:
$ cat $HOME/.config/erdtree/.erdtreerc
# Long or short names work
-s size
# I prefer physical size
--disk-usage physical
# ooo pwetty
--icons
# This is prettier.. thanks bryceberger
--size-left
--prune
A common question people have about erdtree is how it benefits from parallelism when disk I/O does serial processing, i.e. it can only ever service one request at a time.
The idea behind leveraging parallelism for disk reads is that despite serial processing you'll still get higher throughput as saturating the disk queue depth with user-space requests allows it to process requests in aggregate rather than waiting for a single-thread to send a single request at a time and doing some CPU-bound work with the response before sending another.
Here are some crude benchmarks demonstrating the relationship between performance and thread-count.
It's important to note that some parallelism does improve performance but after a certain threshold you do get dimishing returns. As Amdahl's law suggests, there is an asymptotic threshold for the speedup which is a function of thread-count. Once you've approached that threshold you're just paying the additional cost of managing a larger thread-pool with no added benefit.
If you'd like more rigorous empirical data going into how parallelism benefits both SSD and HDD checkout this article.
Disk usage is reported using binary prefixes by default (e.g. 1 KiB = 1024 B) as opposed to SI prefixes (1 KB = 1000 B). To toggle between the two use the -p, --prefix option.
Logical sizes are reported by default but you can toggle the reporting to physical sizes which takes into account compression, sparse files, and actual blocks allocated to a particular file via the following option:
-d, --disk-usage <DISK_USAGE> Print physical or logical file size [default: logical] [possible values: logical, physical]
- A directory will have a size equal to the sum of the sizes of all of its entries.
- Hidden files, files excluded by
.gitignore, and files excluded via globbing will be omitted from the disk usages of their parent directories. - Files/Directories that don't have read permissions will be omitted from the disk usages of their parent directories.
- Special files such a named pipes, sockets, etc. have negligible sizes so their disk usage aren't reported.
- If symlink following is not enabled via
-S, --follow-links, the disk usages of their target will not be reported nor considered. - If symlink following is enabled the size of the target will be reported and considered as part of the total of the symlink's ancestral directories.
- The parts of the file-tree that branch from the symlink that's followed are printed in a different color.
If you happen to have multiple hardlinks pointing to the same underlying inode in a given file-tree, everything subsequent to the first will be skipped and ignored as to not be double counted in the overall disk-usage.
Files are printed in ANSI colors specified according to the LS_COLORS environment variable on GNU/Linux systems. In its absence a default value is used.
Note for MacOS: MacOS uses the LSCOLORS environment variable to determine file colors for the ls command which is formatted very differently from LS_COLORS. MacOS systems will fall back on the aforementioned default value unless the user defines their own LS_COLORS environment variable.
Icons (enabled with I, --icons) are an opt-in feature because for icons to render properly it is required that the font you have hooked up to your terminal emulator contains the glyphs necessary to properly render icons.
If your icons look something like this:
this means that the font you are using doesn't include the relevant glyphs. To resolve this issue download a NerdFont and hook it up to your terminal emulator.
--completions is used to generate auto-completions for common shells so that the tab key can attempt to complete your command or give you hints; where you place the output highly depends on your shell as well as your setup. In my environment where I use zshell with oh-my-zsh, I would install completions like so:
$ et --completions zsh > ~/.oh-my-zsh/completions/_et
$ source ~/.zshrc
-r, --report offers a more traditional du-like view of disk usage info with the additional of file-type identifiers you'd expect on ls -l for POSIX systems or Get-ChildItem on Windows.
This is not a rewrite of the tree command thus it should not be considered a 1-to-1 port. While the spirit of tree is maintained erdtree there are more differences than there are similarities.
Exa is a powerful modern equivalent of the ls command which gives the option to print a tree-view of a specified directory, however the primary differences between exa --tree and et are:
exa --tree --git-ignoredoesn't respect.gitignorerules on a per directory basis whereasetdoes. Withexathe root's.gitignoreis considered, but if child directories have their own.gitignorethey are disregarded and all of their contents will be printed.etdisplays the total size of a directory as the sum of all of its entries' sizes whereasexadoes not support this. This makes sorting directories in the tree-view by size dubious and unclear. Below are screenshots comparing equivalent usages ofetandexa, using long option names for clarity.
dua is a fantastic interactive disk usage analyzer that serves as a modern alternative to ncdu. If you're in the mood for something interactive, dua might suit you more. If you'd rather do a quick analysis of your file-tree and disk-usage without spinning up an entire terminal UI then go with erdtree.
dust is another fantastic tool, but it's one that heavily overlaps with erdtree in functionality. On the surface you'll find that the biggest differences are the out-of-the-box defaults - but of course you can override erdtree's defaults with a config file if you so choose - as well as the UI.
On the topic of performance you'll find that there is negligible difference between the two. In the following crude benchmark the options supplied to erdtree make it mirror dust as closely as possible in behavior with the exception of icons.
Ultimately you should give both tools a try and see which one best suits you :]
Happy to accept contributions but please keep the following in mind:
- If you'd like to add a feature please open up an issue and receive approval first unless you've previously contributed. You can also start a discussion.
- If new arguments/options are added please do your best to keep them sensibly alphabetized. Also be sure to update the [Usage][#usage] section of the README.
- The code is heavily documented so please follow suit.
cargo doc --opencan be extremely helpful. - Feature adds generally require tests.
- If no one is assigned to an
up for grabsissue feel free to pick it up yourself :]
Feature requests in the form of issues in general are welcome.
- to luccahuguet on Github) for suggesting that the compiled
erdtreebinary be shorted toet. - to messense for getting this on Homebrew-core!
- to fawni for getting this on Scoop!
- to 0323pin for getting this on NetBSD!
- to all contributors :]
Q: Why did you make this? It's totally unnecessary.
A: Ennui.
Q: Why is it called erdtree?
A: It's a reference to Elden Ring.
Q: Is it any good?
A: Yes.
Q: Got any testimonials?
Q: Is it blazingly fast?
A: I wrote it in Rust so it should be blazingly fast.
