https://github.com/foiovituh/bakpak
A minimal Bash tool to compress any folder into a timestamped archive 💾
https://github.com/foiovituh/bakpak
backup backup-script backup-tool backup-utility bash-script cli-script cron shell-script targz
Last synced: 7 months ago
JSON representation
A minimal Bash tool to compress any folder into a timestamped archive 💾
- Host: GitHub
- URL: https://github.com/foiovituh/bakpak
- Owner: foiovituh
- License: mit
- Created: 2025-06-28T13:16:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-29T13:48:31.000Z (7 months ago)
- Last Synced: 2025-06-29T14:23:53.815Z (7 months ago)
- Topics: backup, backup-script, backup-tool, backup-utility, bash-script, cli-script, cron, shell-script, targz
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BakPak 💾
A minimal Bash utility that turns any directory into a timestamped, compressed archive.
## Summary 📝
- [BakPak 💾](#bakpak-)
- [Summary 📝](#summary-)
- [Confirmed Working On ✅](#confirmed-working-on-)
- [Installation 📦](#installation-)
- [Usage 🚀](#usage-)
- [Automation ⏰](#automation-)
- [Do you want help me? 👥](#do-you-want-help-me-)
- [License 🏳️](#license-️)
## Confirmed Working On ✅
| Component | Version / Notes |
| ----------- | -------------------------------------- |
| **Bash** | 5.2.21 (GNU) |
| **GNU tar** | 1.35 |
| **gzip** | 1.12 |
| **OS** | Ubuntu 24.04 (kernel 6.8.0-60-generic) |
## Installation 📦
```bash
# 1. Clone the repository
$ git clone https://github.com/foiovituh/bakpak.git
$ cd bakpak
# 2. Make the script executable
$ chmod +x bakpak.sh
# 3 Install system‑wide
$ sudo ln -s "$PWD/bakpak.sh" /usr/local/bin/bakpak
```
## Usage 🚀
Required:
```bash
-f Directory to back up (must be readable)
-t Directory to store the compressed archive (must be writable)
```
Optional:
```bash
-v Show script version
-h Show a help message
-u Uncompressed mode - create .tar archive
-d Dry-run mode — no backups will be created, only displayed
```
Examples:
```bash
bakpak -f ~/Documents -t /mnt/docs_backup
bakpak -f ~/Tests -t /mnt/backup_simulations -d
bakpak -f ~/projects/president -t /mnt/d/band -p uncompressed_site_project -u
```
## Automation ⏰
Running a monthly backup at 5 PM on the 1st day of every month with `cron`:
```cron
0 17 1 * * /usr/local/bin/bakpak -f /home/president/Documents -t /mnt/backups
```
## Do you want help me? 👥
If you have any ideas or wish to contribute to the project, contact me on X (@ohtoaki) or send me a pull request :)
## License 📄
Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.