Repolode
Submit
lra

lra/mackup

Command-line tool that backs up application config files to a synced folder like Dropbox and restores them on new machines.

View on GitHub
Stars
15,358
Forks
939
Open issues
292
Last commit
2 months ago

What is it?

Mackup backs up configuration files for a long list of applications and restores them on a new workstation. It tracks only pure config files, leaving out caches and machine-specific data, and stores them in a folder such as Dropbox, Google Drive, iCloud, or any folder a sync tool can manage.

It works in two modes. Copy mode runs `mackup backup` and `mackup restore` to copy files into and out of the Mackup folder. Link mode moves config files into that folder and replaces the originals with symlinks, so several machines stay in sync. The README warns that link mode breaks preferences on macOS Sonoma and later, so copy mode is the recommended choice there.

Mackup runs on macOS and GNU/Linux and is installed with Homebrew or pip. Users can limit commands to a single application, and they can add their own files or directories through a `~/.mackup` setup.

Key features

  • 01Backs up and restores config files for many named applications.
  • 02Supports copy mode and symlink-based link mode.
  • 03Works with Dropbox, Google Drive, iCloud, or any folder a sync tool handles.
  • 04Commands can target a single application.
  • 05Lets users sync custom files and directories via ~/.mackup.

Use cases

  • Moving to a new Mac or Linux machine and restoring your editor, shell, and app settings.
  • Keeping dotfiles and app preferences consistent across a home and work computer.
  • Syncing personal config files such as ~/.gitignore or ~/.config entries through a cloud folder.

Quick start

  1. 1

    Install Mackup with Homebrew (macOS or Linux)

    brew install mackup
  2. 2

    Install Mackup with pip (other platforms)

    pip install --upgrade mackup
  3. 3

    Launch Mackup and back up your files

    mackup backup
  4. 4

    On a new workstation, restore your files

    mackup restore

Things to know

  • Link mode breaks preferences on macOS Sonoma and later, so use copy mode there.
  • Licensed under GPL-3.0, a copyleft license.
  • Box is no longer supported as a storage backend.

In collections

CLI & terminal toolsOpen-source Mac apps

Topics

#backup#dotfiles#configuration#sync#cli#python#macos#linux

FAQ

What is mackup?
Command-line tool that backs up application config files to a synced folder like Dropbox and restores them on new machines. Mackup backs up configuration files for a long list of applications and restores them on a new workstation. It tracks only pure config files, leaving out caches and machine-specific data, and stores them in a folder such as Dropbox, Google Drive, iCloud, or any folder a sync tool can manage.
Is mackup free to use? What license does it have?
mackup is open source under the GPL-3.0 license. Check the license terms before using it in commercial products.
Is mackup still maintained?
Updated within 6 months. The last commit to mackup was on Sep 9, 2026.
What can I use mackup for?
Moving to a new Mac or Linux machine and restoring your editor, shell, and app settings. Keeping dotfiles and app preferences consistent across a home and work computer. Syncing personal config files such as ~/.gitignore or ~/.config entries through a cloud folder.
How do I install mackup?
Install Mackup with Homebrew (macOS or Linux): brew install mackup Install Mackup with pip (other platforms): pip install --upgrade mackup Launch Mackup and back up your files: mackup backup On a new workstation, restore your files: mackup restore
Where can I get mackup?
The source code and installation instructions are on GitHub: https://github.com/lra/mackup

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects