Oliver Surke
c1848f66e8
- completions/_ssr zsh #compdef completion using _arguments/_values
- completions/ssr.bash bash complete -F function (works with bash-completion@2)
- completions/ssr.fish fish completions with __ssr_needs_subcmd predicates
- bin/ssr-completions install/uninstall/status subcommand
- auto-detects $SHELL, --shell zsh|bash|fish|all
- symlinks into user-scoped paths (no sudo):
~/.zsh/completions/_ssr
~/.local/share/bash-completion/completions/ssr
~/.config/fish/completions/ssr.fish
- prints fpath/bash-completion setup hints if not configured
- bin/ssr dispatcher knows `completions`; help line added
- bin/ssr-install offers completion install after schedule prompt
- README Shell completions section, command list, layout entry
Verified:
- zsh -n on _ssr OK; autoload registers function
- bash -n on ssr.bash OK; `complete -p ssr` returns the registration after source
- end-to-end install/status/uninstall against an ephemeral $HOME
Co-authored-by: Cursor <cursoragent@cursor.com>
278 lines
9.7 KiB
Markdown
278 lines
9.7 KiB
Markdown
# ssr — System Sync & Restore for macOS
|
||
|
||
Reproducible macOS setup in one command. `ssr` snapshots your Homebrew bundle and application configs to a cloud drive on a schedule, and can rebuild a fresh Mac from that snapshot.
|
||
|
||
- **Backup** (`ssr sync`): dumps `Brewfile` and runs `mackup backup` to the configured cloud directory.
|
||
- **Restore** (`ssr restore`): installs Homebrew, replays the `Brewfile`, restores `mackup` configs, applies macOS defaults.
|
||
- **Scheduled sync**: native macOS `launchd` agent (daily by default).
|
||
- **Cloud storage**: iCloud Drive, Dropbox, Google Drive, OneDrive, or any custom path — selectable via config.
|
||
- **No secrets**: all state lives in your cloud drive; the repo only contains code and config templates.
|
||
|
||
> Successor to the original `system_sync.sh` / `system_restore.sh`. Same intent, modernized tooling, modular, idempotent, scheduled by default.
|
||
|
||
---
|
||
|
||
## Requirements
|
||
|
||
- macOS (Apple Silicon or Intel)
|
||
- Bash 3.2+ (preinstalled)
|
||
- Network access for the initial Homebrew install
|
||
- A cloud drive folder you control (iCloud Drive is the default)
|
||
|
||
---
|
||
|
||
## Install
|
||
|
||
```bash
|
||
git clone https://git.surke.de/osurke/system-sync-restore.git ~/.ssr
|
||
cd ~/.ssr
|
||
./install.sh
|
||
```
|
||
|
||
`install.sh` will:
|
||
|
||
1. Symlink `bin/ssr` into `~/.local/bin` (override with `SSR_PREFIX`).
|
||
2. Seed `~/.config/ssr/ssr.conf` from `config/ssr.conf.example` (chmod 600).
|
||
3. Optionally enable the scheduled daily sync.
|
||
|
||
If `~/.local/bin` is not on your `PATH`, add it to your shell rc:
|
||
|
||
```bash
|
||
export PATH="$HOME/.local/bin:$PATH"
|
||
```
|
||
|
||
---
|
||
|
||
## Usage
|
||
|
||
```text
|
||
ssr install First-time install: link binary, seed config, schedule sync
|
||
ssr sync One-shot backup → cloud
|
||
ssr restore [Brewfile] Restore the machine; Brewfile defaults to the cloud copy
|
||
ssr update [--dry-run] Pull latest ssr code, refresh launchd if needed
|
||
ssr schedule on|off Enable/disable the daily launchd job
|
||
ssr config show|edit Show or edit the active config
|
||
ssr completions install Install zsh/bash/fish tab-completion
|
||
ssr status Show config, cloud target, last sync, schedule state
|
||
ssr version Print version
|
||
```
|
||
|
||
### First backup
|
||
|
||
```bash
|
||
ssr sync
|
||
```
|
||
|
||
Output structure in the cloud drive:
|
||
|
||
```
|
||
<cloud root>/
|
||
├── BACKUP/
|
||
│ └── <hostname> - <hardware-uuid>/
|
||
│ ├── Brewfile
|
||
│ └── Brewfile.bak
|
||
└── Mackup/
|
||
└── … (managed by mackup)
|
||
```
|
||
|
||
### Restore on a new machine
|
||
|
||
```bash
|
||
git clone https://git.surke.de/osurke/system-sync-restore.git ~/.ssr
|
||
cd ~/.ssr && ./install.sh
|
||
ssr restore
|
||
```
|
||
|
||
By default `ssr restore` picks the Brewfile from `<cloud>/BACKUP/<host> - <uuid>/Brewfile`. To restore from a different machine's snapshot, pass an explicit path:
|
||
|
||
```bash
|
||
ssr restore "$HOME/Library/Mobile Documents/com~apple~CloudDocs/BACKUP/oldhost - ABCD-1234/Brewfile"
|
||
```
|
||
|
||
---
|
||
|
||
## Configuration
|
||
|
||
Config lives in `~/.config/ssr/ssr.conf` (override with `--config` or `$SSR_CONFIG`). The file is sourced by bash but only recognised `KEY=VALUE` lines are accepted; anything else causes `ssr` to abort.
|
||
|
||
| Key | Default | Purpose |
|
||
|-----|---------|---------|
|
||
| `SSR_CLOUD_PROVIDER` | `icloud` | `icloud`\|`dropbox`\|`googledrive`\|`onedrive`\|`custom` |
|
||
| `SSR_CLOUD_PATH` | — | Absolute path; only used when provider is `custom` |
|
||
| `SSR_BACKUP_SUBDIR` | `BACKUP` | Subfolder for per-host backups |
|
||
| `SSR_MACKUP_SUBDIR` | `Mackup` | Subfolder used by mackup |
|
||
| `SSR_BREW_UPGRADE` | `true` | Run `brew upgrade` during sync |
|
||
| `SSR_BREW_CLEANUP` | `true` | Run `brew cleanup` after sync |
|
||
| `SSR_DISABLE_GATEKEEPER` | `false` | Run `spctl --global-disable` during restore (security trade-off) |
|
||
| `SSR_OPEN_CASKS` | `false` | Open every installed cask after restore for first-run config |
|
||
| `SSR_MACOS_DEFAULTS` | repo's `config/macos-defaults.sh` | Override path to your own defaults script |
|
||
| `SSR_LAUNCHD_LABEL` | `de.surke.ssr.sync` | launchd job label |
|
||
| `SSR_SCHEDULE_HOUR` | `9` | Daily run hour (0–23, local time) |
|
||
| `SSR_SCHEDULE_MINUTE` | `0` | Daily run minute |
|
||
| `SSR_PREFIX` | `$HOME/.local/bin` | Install prefix for the `ssr` symlink |
|
||
| `SSR_STATE_DIR` | `$HOME/.local/state/ssr` | Internal state directory |
|
||
| `SSR_LOG_DIR` | `$HOME/.local/state/ssr/logs` | launchd log directory |
|
||
|
||
### Cloud provider paths resolved automatically
|
||
|
||
| Provider | Resolved root |
|
||
|----------|---------------|
|
||
| `icloud` | `~/Library/Mobile Documents/com~apple~CloudDocs` |
|
||
| `dropbox` | `~/Library/CloudStorage/Dropbox*` (fallback `~/Dropbox`) |
|
||
| `googledrive` | `~/Library/CloudStorage/GoogleDrive-*` |
|
||
| `onedrive` | `~/Library/CloudStorage/OneDrive-*` |
|
||
| `custom` | Value of `SSR_CLOUD_PATH` |
|
||
|
||
---
|
||
|
||
## Shell completions
|
||
|
||
`ssr install` offers to install completions automatically. To do it manually later:
|
||
|
||
```bash
|
||
ssr completions install # detects $SHELL
|
||
ssr completions install --shell all # zsh + bash + fish
|
||
ssr completions status # show what's wired up
|
||
ssr completions uninstall --shell all
|
||
```
|
||
|
||
Targets (user-scoped, no sudo):
|
||
|
||
| Shell | Path |
|
||
|-------|------|
|
||
| zsh | `~/.zsh/completions/_ssr` |
|
||
| bash | `~/.local/share/bash-completion/completions/ssr` |
|
||
| fish | `~/.config/fish/completions/ssr.fish` |
|
||
|
||
For zsh, ensure `~/.zsh/completions` is on `$fpath` (the installer prints the snippet for `~/.zshrc` if it isn't already). For bash, you need [`bash-completion@2`](https://github.com/scop/bash-completion) sourced from your shell rc — Homebrew install path is also printed. Fish needs no extra setup.
|
||
|
||
After installation, open a fresh shell or `exec $SHELL` and `ssr <TAB>` lists the available commands.
|
||
|
||
---
|
||
|
||
## Scheduled sync
|
||
|
||
```bash
|
||
ssr schedule on # write & load ~/Library/LaunchAgents/<label>.plist
|
||
ssr schedule off # unload & remove
|
||
ssr schedule status # check
|
||
```
|
||
|
||
Logs land in `$SSR_LOG_DIR/sync.out.log` and `sync.err.log`. Tail them:
|
||
|
||
```bash
|
||
tail -f ~/.local/state/ssr/logs/sync.err.log
|
||
```
|
||
|
||
Show launchd-level details:
|
||
|
||
```bash
|
||
launchctl list | grep ssr
|
||
log show --predicate 'process == "ssr"' --last 1h
|
||
```
|
||
|
||
---
|
||
|
||
## Updating
|
||
|
||
Updates happen on three independent layers:
|
||
|
||
**Tool code (this repo).** Self-update via `ssr update`:
|
||
|
||
```bash
|
||
ssr update # git pull --ff-only on the clone, then refresh side-effects
|
||
ssr update --dry-run # show what would change, don't pull
|
||
```
|
||
|
||
`ssr update` will:
|
||
|
||
- Refuse if the working tree is dirty or HEAD is detached.
|
||
- Fast-forward only — never rewrites history.
|
||
- Re-render and reload the launchd plist if `launchd/` or `bin/ssr*` changed *and* the schedule is currently active.
|
||
- Print added config keys when `config/ssr.conf.example` gained new options.
|
||
|
||
**Backup data (cloud drive).** Refreshed automatically by the scheduled `ssr sync`. The previous `Brewfile` is preserved as `Brewfile.bak`; deeper history is provided by the cloud provider's built-in version retention (iCloud Drive, Dropbox, …). Trigger an on-demand sync with `ssr sync`.
|
||
|
||
**Dependencies (Homebrew, mackup).** `ssr sync` runs `brew upgrade` and `brew cleanup` when `SSR_BREW_UPGRADE=true` / `SSR_BREW_CLEANUP=true` (both default `true`). Set them to `false` in `ssr.conf` to keep snapshots without auto-upgrading installed packages.
|
||
|
||
---
|
||
|
||
## Project layout
|
||
|
||
```
|
||
.
|
||
├── install.sh # Thin wrapper around bin/ssr-install
|
||
├── bin/
|
||
│ ├── ssr # CLI dispatcher
|
||
│ ├── ssr-install # Local install + scheduling
|
||
│ ├── ssr-update # Self-update (git pull + launchd refresh)
|
||
│ ├── ssr-sync # Backup to cloud
|
||
│ ├── ssr-restore # Rebuild a Mac from the backup
|
||
│ ├── ssr-schedule # launchd on/off/status
|
||
│ ├── ssr-config # show/edit/path
|
||
│ ├── ssr-completions # install zsh/bash/fish completions
|
||
│ └── ssr-status # state summary
|
||
├── lib/
|
||
│ ├── common.sh # Logging, validation, config loader
|
||
│ ├── cloud.sh # Provider abstraction
|
||
│ ├── brew.sh # Homebrew install + Brewfile ops
|
||
│ ├── mackup.sh # Mackup install + backup/restore
|
||
│ └── macos.sh # macOS-specific actions (Rosetta, defaults, etc.)
|
||
├── config/
|
||
│ ├── ssr.conf.example # Reference user config
|
||
│ └── macos-defaults.sh # Default macOS preferences
|
||
├── completions/
|
||
│ ├── _ssr # zsh
|
||
│ ├── ssr.bash # bash
|
||
│ └── ssr.fish # fish
|
||
├── launchd/
|
||
│ └── de.surke.ssr.sync.plist # Template for the scheduled agent
|
||
├── VERSION
|
||
├── LICENSE
|
||
└── README.md
|
||
```
|
||
|
||
All dependencies are inside the repository; the only external requirements are macOS itself and `curl` (for the one-time Homebrew bootstrap).
|
||
|
||
---
|
||
|
||
## Security
|
||
|
||
- No secrets in this repo. All cloud data lives in the user's cloud drive.
|
||
- The config file is sourced but **validated**: only `# comments` and `KEY=VALUE` lines are allowed. Foreign content aborts execution.
|
||
- `chmod 600` is applied to `ssr.conf` and the rendered launchd plist.
|
||
- `SSR_DISABLE_GATEKEEPER=true` is opt-in only; off by default.
|
||
- No remote pipes (`curl … | bash`) except Homebrew's own bootstrap during install.
|
||
|
||
---
|
||
|
||
## Uninstall
|
||
|
||
```bash
|
||
ssr schedule off
|
||
rm -f ~/.local/bin/ssr
|
||
rm -rf ~/.config/ssr ~/.local/state/ssr
|
||
```
|
||
|
||
The cloud data is left untouched.
|
||
|
||
---
|
||
|
||
## Migration from the legacy scripts
|
||
|
||
The old `system_sync.sh` / `system_restore.sh` map onto the new commands:
|
||
|
||
| Legacy | New |
|
||
|--------|-----|
|
||
| `system_sync.sh` | `ssr sync` |
|
||
| `system_restore.sh <Brewfile>` | `ssr restore <Brewfile>` |
|
||
| Manual cron / Lingon entry | `ssr schedule on` |
|
||
| Hard-coded iCloud path | `SSR_CLOUD_PROVIDER` in `ssr.conf` |
|
||
| Inline `.macos` block | `config/macos-defaults.sh` (overridable) |
|
||
|
||
---
|
||
|
||
## License
|
||
|
||
MIT. See [LICENSE](LICENSE).
|