This package contains a bunch of shell scripts that I use to make my life easier when working in a command line. A lot of these scripts are mainly just wrappers around other tools, but with more ✨sparkle✨. A lot of the modifications include adding colours, progress bars, etc, as well as making logging more verbose, and generally just looking pretty.

The only benefit to these tools is they look good - I am almost certain you can find an officially maintained package that includes very similar scripts that do the exact same thing as mine, just with better efficiency.

Still though, if you're a sucker for moving bars and colours, then this is the package for you.

Previously, it was recommended to just add scripts to your PATH. This is no longer the case.

You can now install these scripts using pipx:

$ pipx install git+https://github.com/EEKIM10/cli-utils

$ pip install pipx
$ python3 -m pipx ensurepath

Note: In order to install scripts properly, pip(x) requires that you have python 3.10 or newer.

Once you've installed via pipx, you'll want to ensure that the scripts are on your PATH. By default, pipx installs the scripts into ~/.local/bin, so you'll want to add that to your PATH. Pipx has a useful command for this: pipx ensurepath. It may take a few seconds, but it will ensure that all shells have the correct PATH.

By default, scripts are added to ~/.local/bin, meaning if you want to run them with elevated privileges, you'll need to either add /home/<user>/.local/bin to /root/.profile, or specify the full path (like sudo ~/.local/bin/vrm).

Scripts now attempt to automatically elevate their privileges if they need it - note that this may require a password prompt, which may break the output. Bear in mind that, if you do not add the scripts to root's PATH, the automatic elevation will fail (since elevate spawns the command again in a fresh shell)

In the above table, "Version" refers to the python version that the script was written in. If a script requires a newer python version, such will be stated.

If a script does not work with your python version (e.g. a SyntaxError is raised at runtime), please upgrade your python version. You can also open an issue to ask me to update the minimum python version, or open a PR to do it yourself.

All configuration files are stored in $HOME/.config/cli-utils, even on Windows.

You should not need to edit these files as usually they're controlled by scripts.

Any caches are stored in $HOME/.cache/cli-utils, though caches aren't frequently used. More-often than not, any "cache" files are stored in /tmp (or an equivalent temporary directory).

Not sure why you would be, but basically just make sure it works, and that it's a modification to a current script. I'll only add new scripts if they look really really really useful.