-1
日增长
15,359
stars
940
forks
133
watchers
1,446
prs
723
issues
40
releases
README
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
- mackup link install
- mackup link
- mackup link uninstall
- 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:
bash
Install Mackup
brew install mackup
Launch it and back up your files
mackup backup
If not running macOS or Linux, or you don't like Homebrew, you can use pip.
bash
Install Mackup with PIP
pip install --upgrade mackup
Launch it and back up your files
mackup backup
You're all set and can back up from now on.
Next, on any new workstation, do:
bash
Install Mackup
brew install mackup
Launch it and restore your files
mackup restore
Done!
You can find more detailed instructions in INSTALL.md.
Usage
backup, restore, link install, link uninstall and link operate on all
of your configured applications by default. To limit a command to a single
application, add its name (the identifier shown by mackup list), e.g.
mackup backup vim. Naming an application overrides the
[applications_to_sync] / [applications_to_ignore] settings in your
.mackup.cfg, so you can act on any supported app without editing your config.
mackup backup [application]
Back up your application files. Copy your local config files into the Mackup folder.
Name an application to back up only that one, e.g. mackup backup vim.
mackup restore [application]
Restore your application settings on a newly installed workstation.
Copy config files from the Mackup folder to your home folder.
Name an application to restore only that one, e.g. mackup restore emacs.
mackup link install [application]
Move your local config files into the Mackup folder,
and link them to their original place.
Name an application to install only that one.
$${\color{red}warning}$$ _the link strategy doesn't work correctly on macOS_
mackup link [application]
On another workstation, links local config files from the Mackup folder.
Name an application to link only that one.
mackup link uninstall [application]
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.
Name an application (e.g. mackup link uninstall git) to unlink only that one;
scoping to an application skips the global uninstall confirmation.
mackup list
Display the list of applications supported by Mackup.
mackup -h
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 Top issues
#1386Mackup breaks on macOS Catalina DP1 when using iCloud (path change)31 comments · 2019-06-04#1858Symlinks break after Dropbox update19 comments · 2022-09-05#1127deletion of backup files results in a disaster19 comments · 2018-02-16#1126Bartender plist file gets overwritten17 comments · 2018-02-11#1215Why mackup change files' permission15 comments · 2018-09-04#1312Repeated Dropbox Preferences conflicts for: SizeUp, Bartender, Sketch, Spotify, Terminal…13 comments · 2019-01-29#464Colorsync rule also syncs flux profiles13 comments · 2015-02-10#1890MacOS Ventura - Terminal Preferences not saving (and other apps)12 comments · 2022-12-01
Discussions
#2184Can new releases follow a monthly or bi-weekly cadence?2 comments · 2026-05-14#2160Claude CoWork2 comments · 2026-02-25#2140Does link mean add, or add manually to config? and exclude apps? and is it a backup though?0 comments · 2025-12-04#2090Does the latest release work on the latest MacOS?3 comments · 2025-10-19#2014Is creating symlinks the right model?1 comments · 2024-04-12#2013Is creating symlinks the right model?1 comments · 2024-04-12#2010Possible to have multiple storage engines?1 comments · 2024-03-28#1976Webdav support1 comments · 2023-12-19
Latest release
0.11.3 0.11.3 2026-11-10What's Changed ci: drop macOS 14 runners, add macOS 26 and Ubuntu 26.04 by @lra in https://github.com/lra/mackup/pull/2204 gmailctl - Add XDG configuration path by @brkn in https://github.com/lra/mackup/pull/2203 New Contributors @brkn made their first contribution in https://github.com/lra/mackup/pull/2203 Full Changelog: https://github.com/lra/mackup/compare/0.11.2...0.11.3