path-size is a CLI tool for calculating the (recursive) size of a given file-system path, and sorting subpaths by size. It is like the unix tool du, geared towards finding large files.
$ path-size ./src
Path | Size | Dirs | Files
-------------------------------------------------------------------
./src | 64.24K | 4 | 9
./src/PathSize | 50.16K | 3 | 8
./src/PathSize/Data | 41.30K | 2 | 6
./src/PathSize/Data/SubPathData | 17.98K | 1 | 1
./src/PathSize/Data/SubPathData/Internal.hs | 13.88K | 0 | 1
./src/PathSize.hs | 9.99K | 0 | 1
./src/PathSize/Data/Config.hs | 9.68K | 0 | 1
./src/PathSize/Data/PathData.hs | 4.15K | 0 | 1
./src/PathSize/Utils.hs | 3.77K | 0 | 1
./src/PathSize/Data/PathSizeResult.hs | 2.76K | 0 | 1
Arg: -f,--files-only
Description: Only sizes for files are calculated. All directories are given size 0. Note this effectively implies --ignore-dir-size.
Examples:
$ path-size -f ./
Arg: --ignore-dir-size
Description: Ignores the size of the directories themselves i.e. a directory's size is determined by the sum of all of its subfiles, only. The size of the directory itself (e.g. 4096 bytes on a typical ext4 filesystem) is ignored.
Examples:
$ path-size --ignore-dir-size ./
Arg: --format
Description: Formatting options.
(s|single): Simply, single-line format.(t|tabular): The default. Prints a table.
Examples:
$ path-size --format tabular test/functional/data/success
Path | Size | Dirs | Files
----------------------------------------------------------------
test/functional/data/success/ | 24.60K | 6 | 4
test/functional/data/success/d2 | 16.40K | 4 | 2
test/functional/data/success/d2/d2 | 8.21K | 2 | 1
$ path-size --format single test/functional/data/success
test/functional/data/success: 24.60K, Directories: 6, Files: 4
test/functional/data/success/d2: 16.40K, Directories: 4, Files: 2
test/functional/data/success/d2/d2: 8.21K, Directories: 2, Files: 1
Arg: --no-color
Description: Disables output colors.
Arg: -n,--num-paths (NAT | all)
Description: The number of paths to display. If unspecified, defaults to 10. The option 'all' returns everything.
Examples:
$ path-size -n 20 ./
...
$ path-size -n all ./
...
Arg: -r,--reverse
Description: Paths are sorted in reverse (ascending) order.
Examples:
$ path-size -r ./
Arg: --stable
Description: An additional sorting filter is applied to sort by path name. This allows the sorted order to be deterministic (as paths are unique), at the cost of performance.
Examples:
$ path-size --stable ./
Arg: -s,--strategy (async | sync | pool)
Description: The search strategy is intended to improve performance. The default is async, which uses lightweight threads. The sync option is a sequential search and likely the slowest. Finally, pool uses an explicit thread pool for concurrency. This is potentially the fastest, though experimentation is recommended.
Examples:
$ path-size -s pool ./
Arg: -a, --all
Description: Searches hidden files/directories. We only consider hidden files per the unix dot convention (e.g. .hidden_path). All files are considered unhidden on windows.
Examples:
$ path-size -a ./
Arg: -d,--depth NAT
Description: The depth limit of our search. Note that we still need to fully traverse the file system to get accurate data; this argument merely affects what is reported i.e. any depths > d are implicitly included in parent directories, but not directly.
Examples:
$ path-size -d 1 ./
Arg: -e,--exclude Patterns...
Description: Glob patterns to skip
Examples:
$ path-size -e bar -e foo ./
If you have never built a haskell program before, Cabal is probably the best choice.
The easiest way to install these is generally ghcup.
Once you have cabal and ghc, path-size can be built with cabal build or installed globally (i.e. ~/.cabal/bin/) with cabal install.
Important
Path-size requires git information to be available at build time, for the purposes of including some data in the binary (e.g. commit hash). Cabal's vanilla install method interfers with this, though we have a workaround that relies on passing the current directory as an environment variable:
$ export PATH_SIZE_HOME=$(pwd); cabal install exe:path-sizeNix does not require such a workaround.
Building with nix uses flakes. path-size can be built with nix build, which will compile and run the tests.
Because path-size is a flake, it be built as part of a nix expression. For instance, if you want to add path-size to NixOS, your flake.nix should have:
# flake.nix
{
inputs.path-size.url = "github:tbidne/path-size/main";
}Then include this in the systemPackages:
# wherever your global packages are defined
{
environment.systemPackages = [
path-size.packages."${system}".default
];
}