Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KSXGitHub/parallel-disk-usage
Highly parallelized, blazing fast directory tree analyzer
https://github.com/KSXGitHub/parallel-disk-usage
chart disk-usage du dust filesystem graph pdu rust size
Last synced: about 1 month ago
JSON representation
Highly parallelized, blazing fast directory tree analyzer
- Host: GitHub
- URL: https://github.com/KSXGitHub/parallel-disk-usage
- Owner: KSXGitHub
- License: apache-2.0
- Created: 2021-05-16T07:03:18.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T17:31:21.000Z (about 1 month ago)
- Last Synced: 2024-10-29T18:46:00.387Z (about 1 month ago)
- Topics: chart, disk-usage, du, dust, filesystem, graph, pdu, rust, size
- Language: Rust
- Homepage: https://crates.io/crates/parallel-disk-usage
- Size: 901 KB
- Stars: 446
- Watchers: 6
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - parallel-disk-usage - Highly parallelized, blazing fast directory tree analyzer (Rust)
README
# Parallel Disk Usage (pdu)
[](https://github.com/KSXGitHub/parallel-disk-usage/actions?query=workflow%3ATest)
[](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/benchmark.yaml)
[](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/clippy.yaml)
[](https://github.com/KSXGitHub/parallel-disk-usage/actions/workflows/fmt.yaml)
[](https://crates.io/crates/parallel-disk-usage)
Highly parallelized, blazing fast directory tree analyzer.
## Description
`pdu` is a CLI program that renders a graphical chart for disk usages of files and directories, it is an alternative to [`dust`](https://github.com/bootandy/dust) and [`dutree`](https://github.com/nachoparker/dutree).
## Benchmark
The benchmark was generated by [a GitHub Workflow](https://github.com/KSXGitHub/parallel-disk-usage/blob/0.5.2/.github/workflows/deploy.yaml#L476-L658) and uploaded to the release page.
Programs
* `pdu` v0.8.1
* [`dust`](https://github.com/bootandy/dust) v0.8.1
* [`dua`](https://github.com/Byron/dua-cli) v2.19.2
* [`ncdu`](https://dev.yorhel.nl/ncdu)
* [`gdu`](https://github.com/dundee/gdu) v5.15.0
* `du`
benchmark results
(lower is better)
[_(See more)_](https://github.com/KSXGitHub/parallel-disk-usage-0.10.0-benchmarks/blob/master/tmp.benchmark-report.CHARTS.md)
## Demo
[](https://asciinema.org/a/416663)
[](https://asciinema.org/a/416664)
## Features
* Fast.
* Relative comparison of separate files.
* Extensible via the library crate or JSON interface.
* Optional progress report.
* Customize tree depth.
* Customize chart size.
## Limitations
* Ignorant of hard links: All hard links are counted as real files.
* Do not follow symbolic links.
* Do not differentiate filesystem: Mounted folders are counted as normal folders.
* The runtime is optimized at the expense of binary size.
## Development
### Prerequisites
* [`cargo`](github.com/rust-lang/cargo)
### Test
```sh
./test.sh && ./test.sh --release
```
Environment Variables
| name | type | default value | description |
|---------------|-------------------|---------------|-------------------------------------------------|
| `FMT` | `true` or `false` | `true` | Whether to run `cargo fmt` |
| `LINT` | `true` or `false` | `true` | Whether to run `cargo clippy` |
| `DOC` | `true` or `false` | `false` | Whether to run `cargo doc` |
| `BUILD` | `true` or `false` | `true` | Whether to run `cargo build` |
| `TEST` | `true` or `false` | `true` | Whether to run `cargo test` |
| `BUILD_FLAGS` | string | _(empty)_ | Space-separated list of flags for `cargo build` |
| `TEST_FLAGS` | string | _(empty)_ | Space-separated list of flags for `cargo test` |
### Run
```sh
./run pdu "${arguments[@]}"
```
* `"${arguments[@]}"`: List of arguments to pass to `pdu`.
### Build
#### Debug build
```sh
cargo build --bin pdu
```
The resulting executable is located at `target/debug/pdu`.
#### Release build
```sh
cargo build --bin pdu --release
```
The resulting executable is located at `target/release/pdu`.
### Update shell completion files
```sh
./generate-completions.sh
```
## Extending `parallel-disk-usage`
The [parallel-disk-usage crate](https://crates.io/crates/parallel-disk-usage) is both a binary crate and a library crate. If you desire features that `pdu` itself lacks (that is, after you have asked the maintainer(s) of `pdu` for the features but they refused), you may use the library crate to build a tool of your own. The documentation for the library crate can be found in [docs.rs](https://docs.rs/parallel-disk-usage).
Alternatively, the `pdu` command provides `--json-input` flag and `--json-output` flag. The `--json-output` flag converts disk usage data into JSON and the `--json-input` flag turns said JSON into visualization. These 2 flags allow integration with other CLI tools (via pipe, as per the UNIX philosophy).
Beware that the structure of the JSON tree differs depends on the number of file/directory names that were provided (as CLI arguments):
* If there are only 0 or 1 file/directory names, the name of the tree root would be a real path (either `.` or the provided name).
* If there are 2 or more file/directory names, the name of the tree root would be `(total)` (which is not a real path), and the provided names would correspond to the children of the tree root.
## Installation
### Any Desktop OS
#### From GitHub
Go to the [GitHub Release Page](https://github.com/KSXGitHub/parallel-disk-usage/releases) and download a binary.
#### From [crates.io](https://crates.io)
**Prerequisites:**
* [`cargo`](https://github.com/rust-lang/cargo)
```sh
cargo install parallel-disk-usage --bin pdu
```
### Arch Linux
#### From the [Arch User Repository](https://aur.archlinux.org)
**Prerequisites:**
* An AUR helper, such as [`paru`](https://github.com/Morganamilo/paru)
```sh
paru -S parallel-disk-usage-bin
```
```sh
paru -S parallel-disk-usage
```
#### From [Khải's Pacman Repository](https://github.com/KSXGitHub/pacman-repo)
Follow the [installation instruction](https://github.com/KSXGitHub/pacman-repo#installation) then run the following command:
```sh
sudo pacman -S parallel-disk-usage
```
## Distributions
[](https://repology.org/project/parallel-disk-usage/versions)
## Similar programs
* **CLI:**
* `du`
* [`dust`](https://github.com/bootandy/dust)
* [`dutree`](https://github.com/nachoparker/dutree)
* [`dua`](https://github.com/byron/dua-cli)
* **TUI:**
* [`ncdu`](https://dev.yorhel.nl/ncdu)
* [`gdu`](https://github.com/dundee/gdu)
* [`godu`](https://github.com/viktomas/godu)
* **GUI:**
* [GNOME's Disk Usage Analyzer, a.k.a. `baobab`](https://wiki.gnome.org/action/show/Apps/DiskUsageAnalyzer)
* Filelight
## License
[Apache 2.0](https://git.io/JGIAt) © [Hoàng Văn Khải](https://ksxgithub.github.io/).