lra / mackup

Mackup™ Backup and keep your application settings in sync. Table of contents • Mackup™ • Table of contents • Quickstart • Usage • What does it do • Copy mode • Link mode • - • - Supported Storages • Unsupported Storages • Supported Applications • Can you support application X • Personalization \& configuration • Why did you do this • What platforms are supported • What's up with the weird name • Architecture • Where can I find more information Quickstart On macOS or Linux, if you want an easy install, you can install Homebrew and do: If not running macOS or Linux, or you don't like Homebrew, you can use pip. You're all set and can back up from now on. Next, on any new workstation, do: Done! You can find more detailed instructions in INSTALL.md. Usage Back up your application files. Copy your local config files into the Mackup folder. Restore your application settings on a newly installed workstation. Copy config files from the Mackup folder to your home folder. Move your local config files into the Mackup folder, and link them to their original place. $${\color{red}warning}$$ _the strategy doesn't work correctly on macOS_ On another workstation, links local config files from the Mackup folder. Copy back any synced config file to its original place. Removes the links and copies config files from the Mackup folder back into your home. Display the list of applications supported by Mackup. Get some help, obviously... What does it do By only tracking pure configuration files, it keeps the crap out of your freshly new installed workstation (no cache, temporary and locally specific files are transferred). Mackup makes setting up the environment easy and simple. There are 2 modes of operations: copy mode and link mode. Copy mode Copy mode is used to back up and restore your files. The files are backed up into the configured Mackup folder, which can be in Dropbox, iCloud, or wherever you configure it. It is covered by the 2 commands: • • Link mode > [!WARNING] > If you are using Mackup on a current version of macOS, link mode will BREAK YOUR PREFERENCES. macOS Sonoma (macOS 14) and later don't support symlinked preferences, see issue #2035 for additional information. PR #2085 added copy mode, which should be used instead. Link mode is used to move your config files into the Mackup folder, and link them back to their original place. This mode is useful if you are using multiple workstations, and want to keep your application settings in sync at all times. • Backs up your application settings in a safe directory (e.g. Dropbox) • Syncs your application settings among all your workstations • Restores your configuration on any fresh install in one command line Let's take as an example. Your settings for are saved in your home folder, in the file. It is covered by the 3 commands: • • • If you have Dropbox, these things happen when you launch : • • • Now your config is always backed up and up to date on all your workstations. When you launch , here's what it's really doing: • That's it, you got your config setup on your new workstation. does the same for any supported application. You can revert all your files to their original state. This will remove the symlinks and copy back the files from the Mackup folder in Dropbox to their original places in your home. The Mackup folder and the files in it stay put, so that any other computer also running Mackup is unaffected. Supported Storages • Dropbox • Google Drive • iCloud • Anything able to sync a folder (e.g. Git) See the README file in the doc directory for more info. Unsupported Storages • Box: No longer supported as it ignores dotfiles, see . Supported Applications • 1Password 4 • 2Do • Ack • act • Adium • Adobe Camera Raw • Adobe Illustrator CC • Adobe Photoshop CC • Adobe Photoshop Lightroom CC • Adobe Photoshop Lightroom Classic • aerc • AeroSpace • Affinity Designer • Affinity Photo • Affinity Publisher • Airflow • Airmail • Akamai-CLI • Alacritty • AlDente • AltTab • Amethyst • Ancient Domains of Mystery • Android Studio • Ansible • AppCleaner • AppCode • Apple Music • Apptivate • Arara • aria2c • Arm • Artistic Style • asciinema • asdf version manager • Aspell • Atlantis • Atom • Audacious • AusKey • Autokey • Awareness • AWS Command Line Interface • ActivityWatch • Bartender • Bash it • Bash • Base • Bat • Bc • Beatport Pro • Beets • BetterSnapTool • BetterTouchTool • Beyond Compare • BibDesk • Billings Pro Server Admin • BitBar • Bitchx • Blackfire • Blender • ble.sh • Boto • Boxer • Brackets • Brave • Btop • Bump • Bundler • Byobu • Caffeine • Calibre • Capture One • Cartographica • Cerebro • Charles • Cheat • Chef • Chicken • Choosy • chunkwm • Cider • ClashX • Clasp • Claude Code • CleanShot • Clementine • CLion • ClipMenu • Clipy • CloudApp • Coda 2 • Codex • Colloquy • ColorSchemer Studio 2 • ColorSlurp • ColorSync • Composer • Concentrate • Conky • Consular • Contexts • ControlPlane • CopyQ • CoRD • CotEditor • Ctags • Cursor • cVim • Cyberduck • DaisyDisk • DataGrip • Dash • Day-O • DBeaver • DbVisualizer • Deal Alert • Deepin-dde-dock • Deepin-dde-file-manager • Deepin-Terminal • Default Folder X • Devil's Pie 2 • Devil's Pie>) • dig>) • Divvy • Docker • Dolphin • Doom Emacs • Double Commander • Doxie • Dozer • Draft • Droplr • Dropzone 3 • Drush • Eagle (ogdesign) • EditorConfig • Electrum • Elgato StreamDeck • Emacs • Enjoyable • Environmental Station Alpha • eqMac2 • ESLint • espanso • Exercism • ExpanDrive • Factorio • Factory Droid • Fantastical • fasd • fastlane • FastScripts • Feeds • FileZilla • Finicky • Fish • Fisher • Flake8 • Flameshot • FlexGet • Flux • Focus • Fontconfig • FontExplorer X • Forge • Fork • ForkLift • Franz • Gas Mask • gdb • Gear Player • GeekTool • GHCi • Ghidra • Ghostty • Ghostwriter • Gimp • Git Hooks • Git • Gitbox • GitFox • GitHub CLI • GitKraken • GitUp • Gmail Notifr • gmailctl • GMVault • Gnome SSH Tunnel Manager • GnuPG • GNU Stow • Go2Shell • Goku • GoL…