9 breaking releases

0.10.0 Sep 11, 2020
0.9.0 Jul 12, 2020
0.8.0 Jul 9, 2020

#111 in Filesystem

Download history 139/week @ 2020-06-13 292/week @ 2020-06-20 256/week @ 2020-06-27 163/week @ 2020-07-04 141/week @ 2020-07-11 93/week @ 2020-07-18 145/week @ 2020-07-25 139/week @ 2020-08-01 78/week @ 2020-08-08 63/week @ 2020-08-15 51/week @ 2020-08-22 119/week @ 2020-08-29 115/week @ 2020-09-05 107/week @ 2020-09-12

591 downloads per month

MIT license

3MB
6K SLoC

diskonaut

demo

How does it work?

Given a path on your hard-drive (which could also be the root path, eg. /). diskonaut scans it and indexes its metadata to memory so that you could explore its contents (even while still scanning!).

Once completed, you can navigate through subfolders, getting a visual treemap representation of what's taking up your disk space. You can even delete files or folders and diskonaut will track how much space you've freed up in this session.

Installation

Download a prebuilt binary

If you're using linux, you can check out the "releases" of this repository to download the latest prebuilt binary.

With cargo (linux/macOS)

cargo install diskonaut

Fedora/CentOS

sudo dnf install diskonaut

For older Fedora releases and CentOS available in COPR:

sudo dnf copr enable atim/diskonaut -y
sudo dnf install diskonaut

Arch Linux

Available in the AUR:

yay diskonaut

Gentoo

Available through the following overlay as sys-fs/diskonaut:

https://github.com/telans/EBUILDS

Nix / NixOS

Available in nixpkgs:

$ nix-env --install diskonaut
$ # (Or using the attribute name, which is also diskonaut.)

FreeBSD

Available in freshports:

pkg install diskonaut

macOS

Available in Homebrew

brew install diskonaut

Also available in nixpkgs: see Nix section for more details.

Supported platforms

Right now diskonaut supports linux and macos. If you're on a different operating system and would like to help port it, that would be amazing!

Usage

Either start diskonaut in the folder you want to scan, or provide it with the folder you'd like to scan as an argument:

$ diskonaut /home/aram

Contributing

Contributions of any kind are very much welcome. If you think diskonaut is cool and you'd like to hack at it, feel free to look through the issues. Take a look especially at ones marked "help wanted" or "good first issue". Also, if you found a bug or have an idea for a new feature, please feel free to open an issue to discuss it.

For more detailed information, please see the CONTRIBUTING.md file at the root of this repository.

If at any point you feel stuck, are unsure how to begin or what to work on, please do not hesitate to reach out to me personally: aram@poor.dev

License

MIT

Dependencies

~6MB
~110K SLoC