# Install
 git clone https://github.com/TomfromBerlin/diskguard ~/.config/zsh/plugins/diskguard
 source ~/.config/zsh/plugins/diskguard/diskguard.plugin.zsh

This is is quick&dirty. For a better (more sophisticated) installation (also with the plugin manager or framework of your choice), see the 🛠️ Install section.

echo $ZSH_VERSION

Upgrade: See zsh.org

• awk: scripting language for editing and analyzing texts
• cp: copy files from one place to another
• cut: remove sections from each line of files
• df: Checks and displays the free disk space. Only mounted partitions are checked
• du: Checks and displays the used disk space
• grep: print lines that match patterns
• lsb_release: print distribution specific information
• mv: rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY
• rm: remove files or directories
• sed: stands for [S]tream [ED]itor and is a Unix tool used to edit text data streams
• sleep: pauses the executing process (essentially itself) for a specified time
• stat: Used here to determine the file system status instead of the file status
• touch: Unix command-line program for changing access and modification timestamps; we use it to create marker files
• tput: initialize a terminal or query terminfo database

If one or more of these tools are unavailable, the plugin will display a message and will not load, but this should only happen under TempleOS and MicroSlop Windows.

# Automatically checked
cp large-file.iso /backup/
# ⚠️  Warning: Partition /backup is 85% full!
# Continue anyway? [y/N]

# Prevents write if not enough space
mv bigdata/ /mnt/small-disk/
# ❌ ERROR: Not enough disk space on /mnt/small-disk!
#    Required: 5 GiB
#    Available: 3 GiB
#    Missing: 2048 MiB

# Smart: skips remote targets
rsync -av files/ user@remote:/backup/  # No local check

Add to your .zshrc:

ZSH Unplugged (my recommendation)

# (Do not use the following 15 lines along with other plugin managers!)
# <------------------------------------------------------------------------------------>
# ZSH UNPLUGGED start
#
# where do you want to store your plugins?
ZPLUGINDIR=$HOME/.config/zsh/plugins
#
# get zsh_unplugged and store it with your other plugins and source it
if [[ ! -d $ZPLUGINDIR/zsh_unplugged ]]; then
  git clone --quiet https://github.com/mattmc3/zsh_unplugged $ZPLUGINDIR/zsh_unplugged
fi
source $ZPLUGINDIR/zsh_unplugged/zsh_unplugged.zsh
#
# extend fpath and load zsh-defer
fpath+=($ZPLUGINDIR/zsh-defer)
autoload -Uz zsh-defer
#
# make list of the Zsh plugins you use (Consider paying attention to the loading order)
repos=(
  # ... your other plugins ...
  TomfromBerlin/diskguard
)

Insert the following code block before autoload -Uz promptinit && promptinit

# insert this block after all completion definitions (the zstyle ':completion [...] stuff)
# for zsh-autocomplete you'll need ZSH Version 5.4 (maybe 5.8) or higher
# read documentation of zsh-autocomplete
if [[ -f "${ZPLUGINDIR}/zsh-autocomplete/zsh-autocomplete.plugin.zsh" ]] ; then
    source "${ZPLUGINDIR}/zsh-autocomplete/zsh-autocomplete.plugin.zsh"
else
    # this will not work with zsh-autocomplete
    # tweak compinit
    alias compinit='compinit-tweak'
    compinit-tweak() {
    grep -q "ZPLUGINDIR/*/*" <<< "${@}" && \compinit "${@}"
    }
    autoload -Uz compinit && compinit -C -d ${zdumpfile}
fi
#now load plugins
plugin-load $repos
# ZSH UNPLUGGED end

💡 Best practice: place the second code block right before your prompt definitions and - as already mentioned - mandatory before autoload -Uz promptinit && promptinit.

Other pluginmanagers and frameworks:

Antigen

add to your .zshrc:

antigen bundle TomfromBerlin/diskguard

Oh-My-Zsh

Enter the following command on the command line and confirm with Return

git clone https://github.com/TomfromBerlin/diskguard ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/diskguard

then add to your .zshrc:

plugins=(... diskguard)

Zinit

add to your .zshrc:

zinit light TomfromBerlin/diskguard

You can load the plugin with any other pluginmanagers as well.

⚠️ Regardless which pluginmanager you use, the plugin may interfere with other plugins that monitor disk operations or use the wrapped commands (cp, mv, rsync). ⚠️

manual call via the command line

git clone https://github.com/TomfromBerlin/diskguard ~/.config/zsh/plugins/diskguard
echo "source ~/.config/zsh/plugins/diskguard/diskguard.plugin.zsh" >> ~/.zshrc
source ~/.zshrc

This causes the plugin to load at the very end of the session startup. If you want to load the plugin earlier, you need to manually edit your zshrc-file and move the line source ~/.config/zsh/plugins/disk-guard/diskguard.plugin.zsh to the desired position.

Simply remove the entry from your plugin list (or remove the line where the plugin file is included) and restart Zsh.

🚫 Temporary Disable

zshdg disable

❌ To completely remove:

zshdg unload
rm -rf ~/.config/zsh/plugins/diskguard

Of course, you need to remove the entry from your plugin list (or the line where the plugin file is sourced) from your zshrc-file. Otherwise, the plugin will likely be reinstalled the next time you start a session.

# This settings can be changed at runtime. To do this, enter one or more of the
# following commands in the command line:

# set disk usage warning threshold to 90% (default value: 80%)
zshdg threshold 90

# set scan threshold for deep check to 500 MiB (default value: 100 MiB)
zshdg scan-threshold 500

# Enable debug output (default: off)
zshdg debug 

# disable plugin (default: enable)
zshdg disable

# Run 'zshdg' to display more commands. Each command has several ways
# (long, medium, short) to invoke it.

# After changing a value with on of these commands you'll find a file
# named 'diskguard.conf' in the plugin directory.
# You can edit this file to change the settings, too.

# ──────────────────────────────────────────────────────────────────
# Do not play around with the following settings! I'm serious!

# commands to be wrapped, separated by spaces (default: "cp mv rsync")
export DISKGUARD_COMMANDS="cp mv rsync"

# However, if you want to change the default (not recommended!),
# further customization is required, i.e. you need to create suitable wrappers.
# See the diskguard_cp() function to see how this can be done.
# ──────────────────────────────────────────────────────────────────