shell-recipes

Practical shell scripts for backups, automation, and daily developer workflows.

Goals

• Keep scripts organized so the repository can grow cleanly over time.
• Separate reusable scripts from local private configuration.
• Block accidental commits of secrets, tokens, and private keys.
• Provide ready-to-run examples with safe defaults.

Directory Layout

shell-recipes/
├── .githooks/                 # Versioned git hooks for this repository
├── config/                    # Example configs only; real configs stay local
├── docs/                      # Usage notes and future script docs
├── scripts/
│   ├── dev/                   # Repository maintenance helpers
│   ├── git/                   # Git and backup related scripts
│   └── lib/                   # Shared shell helpers
├── templates/                 # Scheduling templates for cron / launchd
└── runtime/                   # Local logs and runtime files (gitignored)

Privacy Rules

This repository is designed so that scripts can be committed, while personal data stays local.

• Commit only *.example.env template files.
• Put real values in config/*.local.env or another ignored file.
• runtime/ and log files are ignored by git.
• A versioned pre-commit hook scans staged changes for common secrets before commit.

Install the repository hook once:

./scripts/dev/setup-hooks.sh

First Script: Git Auto Backup

The first script is scripts/git/auto-backup.sh.

It is intended for document-style repositories that you want to back up automatically:

• checks the target repository
• supports one repository or a repository list
• records execution logs
• stages changes
• creates a commit only when there are changes
• optionally pushes to remote

Prepare local config

cp config/auto-backup.example.env config/auto-backup.local.env

Then edit the local file with your own values.

If you want to back up several repositories, also copy:

cp config/auto-backup-repos.example.txt config/auto-backup-repos.local.txt

Then set REPO_LIST_FILE in config/auto-backup.local.env.

Run manually

./scripts/git/auto-backup.sh

Or override the repo path directly:

REPO_PATH=/path/to/your/repo ./scripts/git/auto-backup.sh

Or run against a list file:

REPO_LIST_FILE=/path/to/repos.txt ./scripts/git/auto-backup.sh

Schedule it

Templates are included for both cron and macOS launchd:

• templates/cron/auto-backup.cron
• templates/launchd/com.alucpro.shell-recipes.auto-backup.plist

You can also install the schedule automatically:

./scripts/dev/install-auto-backup-schedule.sh

Detailed notes are in docs/scheduling.md.

Logs are written to:

${XDG_STATE_HOME:-$HOME/.local/state}/shell-recipes/auto-backup/

Current Files

• scripts/git/auto-backup.sh: timed backup script for local GitHub repositories
• config/auto-backup-repos.example.txt: example list for multi-repository backup
• scripts/dev/install-auto-backup-schedule.sh: installs or updates cron / launchd schedule
• scripts/dev/setup-hooks.sh: installs versioned git hooks for this repo
• .githooks/pre-commit: blocks common secret leaks before commit

Next Additions

• more scripts grouped by domain, such as filesystem/, network/, macos/
• a small script index table in README.md
• per-script docs in docs/