Skip to content

Scripts 📜#

This prject makes some bash scripts available to help with common tasks. Most of these scripts can be invoked through the CLI.

backup.sh#

Usage: scripts/backup.sh [source_directory] [target_directory]

This script backs up a specified directory into a .tar.gz file
located in the target directory with a timestamped name. 📦

Arguments:
  source_directory   The directory to back up.
  target_directory   The directory where the backup file will be saved.

Options:
  --no-timestamp     Do not append a timestamp to the backup file name.
  -h, --help         Display this help message and exit.

Example:
  scripts/backup.sh /path/to/source /path/to/target

The script uses 'tar' for archiving and gzip compression. 🗜️

Tip

This script can be invoked through the CLI with homelab backup. See the docs for more information.