CLI tool for automatic file backups. You provide input and output paths. The tool watches the input paths, detects file changes, and copies files to the output paths, numerated.
First, install Go: https://golang.org. Then run this:
go install github.com/mitranim/backup@latestThis will compile the executable into $GOPATH/bin/backup. Make sure $GOPATH/bin is in your $PATH so the shell can discover the backup command. For example, my ~/.profile contains this:
export GOPATH="$HOME/go"
export PATH="$GOPATH/bin:$PATH"Alternatively, you can run the executable using the full path. At the time of writing, ~/go is the default $GOPATH for Go installations. Some systems may have a different one.
~/go/bin/backupCreate a configuration file as described below. Run backup -h to view help. Run backup or backup -v to run the tool.
The tool requires a JSON config file where you specify inputs and outputs. By default, it must be called backup.json and located in the current directory. You may provide another config path via -c.
To see all available settings, read the type Config in backup.go. Some settings may be provided both at the top level and in individual entries. The entry overrides take priority.
Example config. Note that file paths may be either absolute or relative to the directory whence you run the tool. When writing Windows paths, use double backslashes \\ as separators. The listed values for debounce, deadline, throttle and limit are the defaults, and should be omitted unless you want to change them.
{
"debounce": "1s",
"deadline": "10s",
"throttle": "10m",
"limit": 128,
"entries": [
{
"input": "/Users/some_user/Documents/some_file_or_directory",
"output": "/Users/some_user/Downloads/some_backups"
},
{
"input": "Documents/another_file_or_directory",
"output": "Downloads/some_backups",
"limit": 64
}
]
}Example config with Windows paths:
{
"entries": [
{
"input": "C:\\Users\\some_user\\Documents\\some_file_or_directory",
"output": "C:\\Users\\some_user\\Downloads\\some_backups"
}
]
}At the time of writing, watching the config file itself doesn't seem to work on Windows. This may also be the case for watching other individual files. Watching directories seems to work. Related issue: rjeczalik/notify#225.