vizex is the terminal program for the UNIX/Linux systems which helps the user to visualize the disk space usage for every partition and media on the user's machine. vizex is highly customizable and can fit any user's taste and preferences.

vizexdf is a new feature that allows to organize and print directory data in the terminal. With a recent release 2.0.4 vizexdf does directory parsing using Asynchronous execution, which improved runtime performance by over 400%.

You can check full release history here.

Installation

pip

vizex can be installed through your terminal and requires Python >= 3.9 and the pip package manager. Here's how to set up Python on your machine.

If you don't have PyPackage Index (PyPI or just pip) installed, Here's the guide on how to install it. Install vizex with the following command:

pip install vizex

If you already have vizex install you'll need to upgrade it:

pip install vizex --upgrade

If you encounter any problems during installation, know that some vizex dependencies require a Python 3 development package on Linux and you need to set up that manually.

For Debian and other derived systems (Ubuntu, Mint, Kali, etc.) you can install this with the following command:

sudo apt-get install python3-dev

For Red Hat derived systems (Fedora, RHEL, CentOS, etc.) you can install this with the following command:

sudo yum install python3-devel

AUR

vizex is available as a package on the AUR (Arch user repository), distributions with AUR support may install directly from the command line using their favorite pacman helper.

Example using yay:

yay -S vizex

How it Works

After installing you can use two terminal commands: vizex to display the disk usage/space and vizexdf, which will print the data of a current working directory with sizes, file types and last modified date.

This will graphically display disk space and usage:

vizex

vizexdf

new feature:

vizextree

you can now print tree of directory structure with the level you want. For example tree with level 1 only

By default level is set to 3 and path is a current path. But you can manually supply path, by just typing path you want to generate tree for, and using -l option to instruct how many levels of directories you want to print.

For example:

vizextree . -level 1

vizex

The best part is that you can modify the colors and style of the display to your preferences with the following commands. For the example above command has excluded two partitions. You can also do give the following options:

-d --header <color>
-s --style <attribute>
-t --text <color>
-g --graph <color>

Display additional details, like fstype and mount point, for each partition:

vizex --details

If you are interested in visualizing a specific path run with the following command:

vizex --path </full/path>

You can also exclude any combination of partitions/disks with multiple -X or for verbose --exclude option:

vizex -X <PartitionName1> -X <PartitionName2> ...

You can also save the partitions full information in csv or in json file, just by calling --save option with the full path where you want your output to be saved:

vizex --save "/home/user/disk_info.json"

And if you are on laptop you can even call your battery information with simple argument:

vizex battery

For a full list of the available options please check:

vizex --help

vizexdf

You can include hidden files and folders by calling --all or -a for short and sort the output with --sort or -s for short based on name, file type, size, or date. Put it in descending order with the --desc option.

You can chain multiple options but make sure to put the -s at the end as it requires a text argument. Example:

vizexdf -ads name

This will print current directory data sorted by name and in descending order and will include hidden files.

Lastly, you save all the modifications by adding -l at the end of the command:

vizex -d red -t blue --details -l

The next time you call vizex / vizexdf it will include all the options listed in the above command. If you decided to change the default calling command for vizex/vizexdf just include -l and it will be overwritten

If you want to contribute to the project you are more than welcome! But first, make sure all the tests run after you fork the project and before the pull request. First, run the access.py, that way tests folder will obtain a path to the main folder and you can run all the tests.

You can get the full set of features by calling --help option with command.