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:

# 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.

# 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:

# 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.