dotbackup.rs

Rust implementation & continuation of dotbackup.

dotbackup is an easy-to-use yet powerful backup utility for dotfiles. Simplicity is its main design principle. With its help, you don't have to maintain extra backup scripts along with dotfiles. What you only need is adding dotfile locations to its configuration. Flexibility is its another design principle. With hooks, one can execute any script during the backup process. So you are not limited to only copy dotfiles, you can use external commands to modify dotfiles or anything you want in a clear and controllable way.

Installation

Choose the appropriate package manager to install.

• crates.io
• AUR

Quick Start

dotbackup divides dotfile backup management into two separate operations - backup and setup. So it has two commands - dotbackup and dotsetup. dotbackup makes backup and dotsetup applies backup.

The first step is to create a configuration of dotbackup. Its location is different on different platforms:

Let's say if you want to make backup of Vim and dotbackup itself, then the configuration woule be like this:

backup_dir: ~/backup
apps:
  vim:
    files: [~/.vimrc]
  dotbackup:
    files: [~/.config/dotbackup/]

backup_dir is where backup files will be stored. Dotfile locations should be specified in a structure of apps.<app_name>.files, so that dotbackup knows which file belongs to which application. Details of the configuration are in the documentation, but the example above should be enough for now.

After saving the configuration, you can make backup by simply execute the command dotbackup. And then ~/.vimrc will be copied to ~/backup/.vimrc, ~/.config/dotbackup/ will be copied to ~/backup/.config/dotbackup/. The backup location of files is determined by their relative paths to the home directory. If you want to only make backup of Vim, just execute dotbackup vim.

Setup is just the inversion of backup. dotsetup applies all the backup, and dotsetup <app_name> only applies specific application's backup.

Documentation

For more information, please read dotbackup(1) and dotsetup(1).

Show Your Support

If you're using dotbackup, consider adding the badge to your dotfile repository's README.md:

[![dotbackup-managed](https://img.shields.io/badge/dotbackup-managed-blue)](https://github.com/jaxvanyang/dotbackup.rs)