os-mnemo/System-Sync-Restore
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Page: Quick start
Pages
Backup structure and sync Commands Configuration reference Home Quick start Repository layout Scheduling logging and updates Security Uninstall and Migration Shell completions
Clone
3
Quick start
Oliver Surke edited this page 2026-05-18 10:24:39 +02:00
Table of Contents

Quick start

Requirements

  • macOS (Apple Silicon or Intel)
  • Bash 3.2+ (preinstalled)
  • Network access for the initial Homebrew install
  • A cloud folder you control (iCloud Drive is the default)

Install

git clone https://git.surke.de/os-mnemo/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:

export PATH="$HOME/.local/bin:$PATH"

First commands

ssr sync              # one-shot backup to cloud
ssr status            # config, cloud target, last sync, schedule

Restore on a new machine after clone + ./install.sh:

ssr restore

Default Brewfile location: <cloud>/BACKUP/<hostname> - <hardware-uuid>/Brewfile. To use another host's snapshot, pass the Brewfile path - see Backup-structure-and-sync.