Convert Figma logo to code with AI

lra logomackup

Keep your application settings in sync (OS X/Linux)

14,514
930
14,514
359
View on GitHub

Top Related Projects

MikeMcQuaid's avatar

strap

2,190

👢 Bootstrap your macOS development system.

holman's avatar

dotfiles

7,272

@holman does dotfiles

thoughtbot's avatar

rcm

3,121

rc file (dotfile) management

anishathalye's avatar

dotbot

7,001

A tool that bootstraps your dotfiles ⚡️

Quick Overview

Mackup is an open-source tool designed to keep your application settings in sync across multiple machines. It backs up your application configurations and syncs them using cloud storage services like Dropbox, Google Drive, or iCloud. This allows you to maintain consistent settings across different computers and easily set up new machines with your preferred configurations.

Pros

  • Supports a wide range of applications and tools (300+)
  • Flexible sync options with various cloud storage providers
  • Easy to use with simple commands for backup and restore
  • Customizable through configuration files

Cons

  • Potential conflicts if syncing between different operating systems
  • May require manual intervention for some application configs
  • Limited support for Windows compared to macOS and Linux
  • Syncing large configuration files can consume significant cloud storage space

Getting Started

  1. Install Mackup:
brew install mackup

  1. Configure Mackup (optional): Create a .mackup.cfg file in your home directory to customize settings.

  2. Back up your files:

mackup backup
  1. Restore files on a new machine:
mackup restore

Note: Ensure your chosen cloud storage service is set up before running Mackup.

Competitor Comparisons

MikeMcQuaid logo

strap

2,190

👢 Bootstrap your macOS development system.

Pros of Strap

  • Focuses on automated macOS setup and configuration
  • Includes Homebrew installation and package management
  • Offers customization through a .Brewfile

Cons of Strap

  • Limited to macOS systems only
  • Requires more setup and configuration compared to Mackup
  • Less flexible for cross-platform use

Code Comparison

Mackup (Python):

def copy(self, src, dst):
    """Actually copy the file."""
    if os.path.islink(src):
        linkto = os.readlink(src)
        os.symlink(linkto, dst)
    else:
        shutil.copy(src, dst)

Strap (Shell):

brew bundle --global
for f in ~/.strap/packages/*; do
  package=$(basename "$f")
  if ! brew list "$package" >/dev/null 2>&1; then
    brew install "$package"
  fi
done

Key Differences

  • Mackup focuses on backing up and syncing application settings across multiple machines
  • Strap is designed for initial macOS setup and ongoing maintenance
  • Mackup supports various operating systems, while Strap is macOS-specific
  • Mackup uses Python for its implementation, whereas Strap primarily uses shell scripts
  • Strap integrates more deeply with Homebrew for package management
holman logo

dotfiles

7,272

@holman does dotfiles

Pros of dotfiles

  • Highly customizable and modular approach to managing configuration files
  • Includes scripts for automated setup and installation of various tools
  • Provides a comprehensive set of configurations for multiple applications

Cons of dotfiles

  • Requires more manual setup and maintenance compared to Mackup
  • May have a steeper learning curve for users new to dotfiles management
  • Less focused on backup and restoration across multiple machines

Code Comparison

dotfiles:

# bootstrap
#!/bin/sh
#
# bootstrap installs things.

cd "$(dirname "$0")/.."
DOTFILES_ROOT=$(pwd -P)

set -e

echo ''

Mackup:

def copy(self, filename):
    """
    Copy a file to its destination.
    """
    # Build the source path
    src = os.path.join(os.environ['HOME'], filename)
    # Build the destination path
    dst = os.path.join(self.mackup_folder, filename)

The dotfiles repository uses shell scripts for setup and configuration, while Mackup utilizes Python for its core functionality. dotfiles offers more flexibility in customization, whereas Mackup focuses on simplifying the backup and restoration process across multiple machines.

thoughtbot logo

rcm

3,121

rc file (dotfile) management

Pros of rcm

  • More lightweight and focused solely on dotfile management
  • Offers greater flexibility in organizing and structuring dotfiles
  • Provides a command-line interface for easier integration with scripts and workflows

Cons of rcm

  • Limited to managing dotfiles only, unlike Mackup's broader application support
  • Requires more manual setup and configuration compared to Mackup's automated approach
  • Less user-friendly for those unfamiliar with command-line tools

Code Comparison

rcm:

rcup -v
lsrc
mkrc ~/.vimrc

Mackup:

mackup backup
mackup restore
mackup list

Summary

rcm is a specialized tool for managing dotfiles, offering greater control and flexibility but requiring more manual setup. Mackup, on the other hand, provides a more comprehensive solution for backing up and syncing various application settings, including dotfiles, with a more automated approach. The choice between the two depends on the user's specific needs and comfort level with command-line tools.

anishathalye logo

dotbot

7,001

A tool that bootstraps your dotfiles ⚡️

Pros of Dotbot

  • Highly customizable with plugin support
  • Allows for complex configurations and symlink management
  • Supports multiple operating systems and environments

Cons of Dotbot

  • Steeper learning curve due to more complex configuration
  • Requires manual setup and maintenance of dotfiles

Code Comparison

Mackup configuration (.mackup.cfg):

[storage]
engine = file_system
path = Dropbox/Mackup

Dotbot configuration (install.conf.yaml):

- clean: ['~']
- link:
    ~/.bashrc: bashrc
    ~/.vimrc: vimrc
- shell:
    - [git submodule update --init --recursive, Installing submodules]

Key Differences

  • Mackup focuses on automatic backup and synchronization of application settings
  • Dotbot provides more granular control over dotfile management and installation
  • Mackup supports a wide range of applications out-of-the-box
  • Dotbot requires manual configuration but offers more flexibility in file organization

Use Cases

  • Choose Mackup for easy, automated backup and sync of app settings across machines
  • Opt for Dotbot when you need fine-grained control over dotfile management and custom installation processes

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Mackup™

Keep your application settings in sync.

Table of contents

WARNING

⚠️ Mackup does not work correctly in Macos Sonoma, since it does not support symlinked files for preferences. Running this code will destroy all user preferences without a means for recovery. For more information, see issues #1924 and 2035.

Quickstart

If you have Dropbox installed and want to use it to save your config files, that's super easy.

On macOS, 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 you don't like Homebrew, you can use pip.

Note: The below command will check if a previous version of Mackup is already installed on your system. If this is the case, it will be upgraded to the latest version.

# Install Mackup with PIP
pip install --upgrade mackup

# Launch it and back up your files
mackup backup

On Ubuntu, pip will install to the current user's home directory rather than system-wide. Because of this, when installing pip on Ubuntu you will need to run pip install with the --system flag as well (on other platforms this is not needed)

You're all set and constantly backed 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

mackup backup

Backup your application settings.

mackup restore

Restore your application settings on a newly installed workstation.

mackup uninstall

Copy back any synced config file to its original place.

mackup list

Display the list of applications supported by Mackup.

mackup -h

Get some help, obviously...

What does it do

  • Back ups 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

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 transfered).

Mackup makes setting up the environment easy and simple, saving time for your family, great ideas, and all the cool stuff you like.

Bullsh*t, what does it really do to my files

Let's take git as an example. Your settings for git are saved in your home folder, in the .gitconfig file.

Backup

If you have Dropbox, these things happen when you launch mackup backup:

  1. cp ~/.gitconfig ~/Dropbox/Mackup/.gitconfig
  2. rm ~/.gitconfig
  3. ln -s ~/Dropbox/Mackup/.gitconfig ~/.gitconfig

Now your git config is always backed up and up to date on all your workstations.

Restore

When you launch mackup restore, here's what it's really doing:

  1. ln -s ~/Dropbox/Mackup/.gitconfig ~/.gitconfig

That's it, you got your git config setup on your new workstation.

mackup does the same for any supported application.

Uninstall

You can revert all your files to their original state.

# Just run this
mackup uninstall

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

See the README file in the doc directory for more info.

Unsupported Storages

Supported Applications

Can you support application X

We can with your help ;)

Personalization & configuration

Have an application that shouldn't be generally supported but that you use? Or a cool file you want to sync?

Why did you do this

Yesterday, I had a talk with Zach Zaro, complaining about the pain it is to reconfigure our Macbook each time we get a new one or install from scratch. That's a talk we have already had months ago.

I change my workstation every X months. Each time I either lose my apps' configurations, or I just waste a bunch of hours getting setup like I was on my old box. I also spend a lot of time reconfiguring the same stuff again on all my workstations (home, work).

Boring...

Some people tried to solve the problem on the application layer, like Github's Boxen, but it solves a different problem, from my point of view. I don't spend a lot of time installing or downloading stuff. I spend time configuring it.

For years, I've used a personal shell script that was copying known config files into Subversion, Git or Dropbox, and linked them into my home. But I felt a lot of us had the same problem: Making a more generic tool could help others and I could get help from others to support more apps in the tool.

So here comes Mackup, the little tool that will sync all your application configs to Dropbox (or Google Drive, or anything).

And it's GPL, of course.

What platforms are supported

  • macOS
  • GNU/Linux

What's up with the weird name

Mackup is just a portmanteau of Mac and Backup. It is simple, short, and easy to remember, and it corresponds with the whole idea of Mackup: the simpler – the better! (And I suck at naming stuff, but who doesn't.)

Where can I find more information

In the doc directory.