ZBackup --backup-made-easy

Learn ZBackup

Guides and tutorials to get you started with ZBackup.

Quick Start

Get up and running in 3 steps
# 1. Clone the repository
git clone https://github.com/KirobotDev/zbackup.git
cd zbackup

# 2. Install dependencies
pip install -r requirements.txt

# 3. Run ZBackup
python main.py

Core Concepts

Creating Backups

ZBackup compresses your selected files and directories into a standard .zip archive. Each backup is stored with a timestamp and can be restored at any time.

python main.py
# Select "Create Backup" from the menu

Listing Backups

View all your existing backups with details like date, size, and name. This helps you quickly find the backup you need to restore.

python main.py
# Select "List Backups" from the menu

Restoring Backups

Choose a backup from the list and ZBackup will extract all files to their original structure. A safe way to undo mistakes.

python main.py
# Select "Restore Backup" then pick a backup

Deleting Backups

Remove backups you no longer need. ZBackup will ask for confirmation before permanently deleting any backup file.

python main.py
# Select "Delete Backup" then pick a backup

Tutorials

Beginner

Your First Backup

Step-by-step guide to creating your very first backup with ZBackup from scratch.

Read the guide →
Beginner

Understanding the CLI

Learn how the interactive terminal interface works and how to navigate the menus.

Read the guide →
Intermediate

Automating Backups

Set up scheduled backups using cron (Linux) or Task Scheduler (Windows).

Read the guide →
Advanced

Contributing to ZBackup

Learn the project structure and how to contribute new features or fix bugs.

Read the guide →

Video Tutorials

Video tutorials are coming soon. Stay tuned for walkthroughs covering every ZBackup feature.