You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-22Lines changed: 14 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,31 +14,33 @@
14
14
15
15
A backup solution for web development projects: multiple source directories, full/incremental/differential backups, compression, integrity verification, and optional cloud (planned).
16
16
17
-
## Quick Start
17
+
## Quick Start (clone and run in 2 minutes)
18
18
19
-
**Run directly (from the repo):**
19
+
Clone, run install (sets permissions, creates dirs, checks tools), run tests, edit config, then backup.
20
20
21
21
```bash
22
-
cd /path/to/backup-webdev
23
-
./webdev-backup.sh # Interactive menu (press Enter for Quick Backup)
24
-
./backup.sh --quick # Quick backup with defaults (no menu)
./install.sh # Sets chmod +x, creates logs/test, checks tools (decline alias/security prompts if you prefer)
25
+
./run-tests.sh # Verify it works (48 tests, no config needed)
25
26
```
26
27
27
-
From the menu, **Quick Backup** is the default: press **Enter** to start a backup with your configured sources and destination. Quick backup shows the same per-folder progress (dashboard) as an interactive run—no prompts for project selection.
28
-
29
-
**Run from anywhere via alias** — add to `~/.bashrc` or `~/.zshrc`:
28
+
Edit `config.sh` — set your **source** and **destination** paths (see [Configuration](#configuration)):
30
29
31
30
```bash
32
-
alias webback='/path/to/backup-webdev/webdev-backup.sh'
31
+
# In config.sh: DEFAULT_SOURCE_DIRS=("$HOME/Developer") # or your project dirs
32
+
# DEFAULT_BACKUP_DIR="$HOME/backups" # where to store backups
33
33
```
34
34
35
-
Use the real path to this cloned repo on your machine (e.g. `$HOME/backup-webdev` or `/Volumes/MyDrive/backup-webdev`). Then either open a new terminal or run`source ~/.zshrc` (or `source ~/.bashrc`) and use:
35
+
Then run:
36
36
37
37
```bash
38
-
webback
38
+
./backup.sh --dry-run # Smoke test (no writes)
39
+
./webdev-backup.sh # Interactive menu — press Enter for Quick Backup
40
+
./backup.sh --quick # Direct quick backup (no menu)
39
41
```
40
42
41
-
You can also run `./setup-alias.sh`from the repo to add the alias for you.
43
+
**Optional:** Run `./setup-alias.sh` to add a `webback`alias. This is a run-from-repo tool — no system-wide install.
42
44
43
45
## Features
44
46
@@ -53,16 +55,6 @@ You can also run `./setup-alias.sh` from the repo to add the alias for you.
0 commit comments