Misaligned columns if one entry is 100%

dua (-> Disk Usage Analyzer) is a tool to conveniently learn about the usage of disk space of a given directory. It's parallel by default and will max out your SSD, providing relevant information as fast as possible. Optionally delete superfluous data, and do so more quickly than rm.

Installation

Binary Release

MacOS

curl -LSfs https://raw.githubusercontent.com/Byron/dua-cli/master/ci/install.sh | \
    sh -s -- --git Byron/dua-cli --crate dua --tag v2.17.4

MacOS via MacPorts:

sudo port selfupdate
sudo port install dua-cli

MacOS via Homebrew

brew update
brew install dua-cli

Linux

Linux requires the target to be specified explicitly to obtain the MUSL build.

curl -LSfs https://raw.githubusercontent.com/Byron/dua-cli/master/ci/install.sh | \
    sh -s -- --git Byron/dua-cli --target x86_64-unknown-linux-musl --crate dua --tag v2.17.4

Windows via Scoop

scoop install dua

Pre-built Binaries

See the releases section for manual installation of a binary, pre-built for many platforms.

Cargo

Via cargo, which can be obtained using rustup

For Unix…

cargo install dua-cli

# And if you don't need a terminal user interface (most compatible)
cargo install dua-cli --no-default-features

# Compiles on most platforms, with terminal user interface
cargo install dua-cli --no-default-features --features tui-crossplatform

For Windows, nightly features are currently required.

cargo +nightly install dua-cli

VoidLinux

Via xbps on your VoidLinux system.

xbps-install dua-cli

Fedora

Via dnf on your Fedora system.

sudo dnf install dua-cli

Arch Linux

Via pacman on your ArchLinux system.

sudo pacman -S dua-cli

NixOS

https://search.nixos.org/packages?channel=23.11&show=dua&from=0&size=50&sort=relevance&type=packages&query=dua

Nix-shell (temporary)

nix-shell -p dua

NixOS configuration

  environment.systemPackages = [
    pkgs.dua
  ];

NetBSD

Via pkgin on your NetBSD system.

pkgin install dua-cli

Or, building from source

cd /usr/pkgsrc/sysutils/dua-cli
make install

Windows

You will find pre-built binaries for Windows in the releases section. Alternatively, install via cargo as in

cargo +nightly install dua-cli

Usage

# count the space used in the current working directory
dua
# count the space used in all directories that are not hidden
dua *
# learn about additional functionality
dua aggregate --help

Interactive Mode

Launch into interactive mode with the i or interactive subcommand. Get help on keyboard shortcuts with ?. Use this mode to explore, and/or to delete files and directories to release disk space.

Please note that great care has been taken to prevent accidential deletions due to a multi-stage process, which makes this mode viable for exploration.

dua i
dua interactive

Development

Please note that all the following assumes a unix system. On Windows, the linux subsystem should do the job.

Run tests

make tests

Learn about other targets

make

But why is…

…there only one available backend? `termion` was available previously.

Maintaining both backends seemed more cumbersome than it's worth and add complexity I didn't like anymore. termion had its benefits, but I never liked that it seems to have dropped out of support. Thus crossterm is the only remaining backend and it's very actively developed.

Acknowledgements

Thanks to jwalk, all there was left to do is to write a command-line interface. As jwalk matures, dua should benefit instantly.

Limitations

Does not show symbolic links at all if no path is provided when invoking dua
- in an effort to skip symbolic links, for now there are pruned and are not used as a root. Symbolic links will be shown if they are not a traversal root, but will not be followed.
Interactive mode only looks good in dark terminals (see this issue)
easy fix: file names in main window are not truncated if too large. They are cut off on the right.
There are plenty of examples in tests/fixtures which don't render correctly in interactive mode. This can be due to graphemes not interpreted correctly. With Chinese characters for instance, column sizes are not correctly computed, leading to certain columns not being shown. In other cases, the terminal gets things wrong - I use alacritty, and with certain characaters it performs worse than, say iTerm3. See https://github.com/minimaxir/big-list-of-naughty-strings/blob/master/blns.txt for the source.
In interactive mode, you will need about 60MB of memory for 1 million entries in the graph.
In interactive mode, the maximum amount of files is limited to 2^32 - 1 (u32::max_value() - 1) entries.
- One node is used as to 'virtual' root
- The actual amount of nodes stored might be lower, as there might be more edges than nodes, which are also limited by a u32 (I guess)
- The limitation is imposed by the underlying petgraph crate, which declares it as unsafe to use u64 for instance.
- It's possibly UB when that limit is reached, however, it was never observed either.

Similar Programs

CLI:
- du
- dust
- dutree
- pdu
TUI:
- ncdu
- gdu
- godu
GUI:
- GNOME's Disk Usage Analyzer, a.k.a. baobab
- Filelight

	pub enum Color {
	/// Use no color
	None,
	/// Use terminal colors
	Terminal,
	}

	pub(crate) struct DisplayColor<C> {
	kind: Color,
	color: C,
	}

	impl Color {
	pub(crate) fn display<C>(self, color: C) -> DisplayColor<C> {
	DisplayColor { kind: self, color }
	}
	}

	impl<C> fmt::Display for DisplayColor<C>
	where
	C: fmt::Display,
	{
	fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
	match self.kind {
	Color::None => Ok(()),
	Color::Terminal => self.color.fmt(f),
	}
	}
	}

	let mut files_or_dirs = vec![path];
	let mut dirs = Vec::new();
	let mut num_errors = 0;
	while let Some(path) = files_or_dirs.pop() {
	let assume_symlink_to_try_deletion = true;
	let is_symlink = path
	.symlink_metadata()
	.map(\|m\| m.file_type().is_symlink())
	.unwrap_or(assume_symlink_to_try_deletion);
	if is_symlink {
	// do not follow symlinks
	num_errors += into_error_count(fs::remove_file(&path));
	continue;
	}
	match fs::read_dir(&path) {
	Ok(iterator) => {
	dirs.push(path);
	for entry in iterator {
	match entry.map_err(io_err_to_usize) {
	Ok(entry) => files_or_dirs.push(entry.path()),
	Err(c) => num_errors += c,
	}
	}
	}
	Err(ref e) if e.kind() == io::ErrorKind::Other => {
	// assume file, save IOps
	num_errors += into_error_count(fs::remove_file(path));
	continue;
	}
	Err(_) => {
	num_errors += 1;
	continue;
	}
	};
	}

	impl WalkOptions {
	pub(crate) fn iter_from_path(&self, path: &Path) -> WalkDir {
	WalkDir::new(path)
	.follow_links(false)
	.sort(match self.sorting {
	TraversalSorting::None => false,
	TraversalSorting::AlphabeticalByFileName => true,
	})
	.skip_hidden(false)
	.process_read_dir(\|_, dir_entry_results\| {
	dir_entry_results.iter_mut().for_each(\|dir_entry_result\| {
	if let Ok(dir_entry) = dir_entry_result {
	dir_entry.client_state = Some(dir_entry.metadata());
	}
	})
	})
	.parallelism(if self.threads == 0 {
	jwalk::Parallelism::RayonDefaultPool
	} else {
	jwalk::Parallelism::RayonNewPool(self.threads)
	})
	}
	}

byron / dua-cli Goto Github PK

dua-cli's Introduction