BAUP

A way to manage and backup your files

This project is a CLI utility to manage and backup certain files in your system across multiple devices. The CLI uses a configurable file to determine which files it needs to backup.

Installation

(If you are using Arch Linux, there is an AUR package called baup-git).

To install the utility, follow the next instructions:

1. Clone the repository in your machine
2. Using cargo/rustc compile the project with the following command: cargo build --release
3. Create a symbolic link using: sudo ln -s /path/to/executable /usr/bin/baup

Alternatively, you can install the utility running the command: sudo sh install.sh

Setup

Before starting to use the utility, you need to set up the auxiliary file. You can create it manually, or run baup edit for creating and editing it.

An example of this file could be:

~/.config/helix/;helix

~/.config/rofi/config.rasi;rofi

/etc/X11/xorg.conf.d/30-touchpad.conf;system
/etc/systemd/logind.conf;system

~/.config/zathura/zathurarc;zathura

~/.config/espanso/;espanso

In this example, all the files in the ~/.config/helix/ directory will be copied to the helix subdirectory, the config.rasi file in the rofi subdirectory,...

Important: If you want to copy all the files of a directory, immediately before the ';' separator you have to add the '/' character. If you don't do this, the program will not work properly.

Usage

The CLI Tool counts with subcommands to execute a certain action, these commands are:

Import

The import command copies all the files specified in the backups file to the directory where this file is located. The commands copies all the files recursively if the origin is a directory, and just the specified file if the origin is a file.

Moreover, the command counts with these options to optimize your workflow:

• partial: (-p,--partial ) Only imports the files where the subdirectory (the part after the ';') is equal to the DIR passed as an argument
• auto-commit: (-c,--auto-commit) After importing the files, it creates a commit in which the message is a list of the changed files (if there are more than 3 files, it will show 3 and then ...)
• zip: (-z,--zip) After importing the files, it creates a zip file containing every file in the subdirectories created. This zip will not include the backups file or the .zip directory

Export

This command has the opposite function as import, copying the files from the backups folder to their original locations. The export command counts, as import did, with the partial (-p,--partial) option for exporting only one part of the files.

Commit

Using git, this command commits the changes made in the backups repository. Any options that you write after baup will be passed as arguments to the git commit command.

For example, if you ran baup commit -m "Test", the program will git add . and git commit -m "Test"

Push

As the commit command did, push uses git to push all the commits made in the repository. Also, the push command will pass any arguments to the git command.

Pull

This command works the same as push or commit, but for pulling any changes to the local repository from the remote repository.

Edit

The edit command will (using your default editor saved in $EDITOR) open the backups file for you to change it in any way you need.

This command counts with a config (-c,--config) flag for opening (and creating if necessary) the configuration file

Diff

The diff command allows the user to check for the changes done in the files to be backed up. As the import and export command, the diff command counts with a partial flag for only checking part of the files.

Clear

The clear command deletes the subdirectories of the backups directory. This command counts with the partial flag for only deleting a subdirectory with the name passed as argument.

Note: Using the partial flag you can delete any subdirectories, not only the ones created by the baup utility

Configuration

The program can be configured using a configuration file. This file will be located in ~/.config/baup/config.toml. The values that can be changed are the following:

• path -> The path to the backups file (~/.baup/files.txt for default)
• auto_commit -> Works the same as the auto-commit option for the import command (false for default)
• import_hook -> A script that will get executed before any files are imported (None for default)
• export_hook -> A script that will get executed before any files are exported (None for default)

An example configuration file can be:

path = "~/Documents/baup/files.txt"

[hooks]
import_hook="~/.config/baup/hooks/import.sh"

As you can see in the example, you don't need to set all the values in the config file for it to work

ZSH completion

_baup is a completion configuration for ZSH. If you want to use it you must paste it in your fpath. If you don't have a fpath directory yet, add this to your .zshrc:

fpath=($HOME/completion_zsh $fpath)

Now in $HOME/completion_zsh you can add completion files like _baup.

Note: you must also add the following to your .zshrc:

autoload -U compinit; compinit

Contributors

• RodAlc24
• ImanolCiganda