Get Started¶

BackUP bup CLI written in Go.

Creates an archive of the source directory and puts it in the destination directory in a sub-folder with the name of the source directory and a timestamped filename.

brew install cssnr/tap/bup

curl 'https://raw.githubusercontent.com/smashedr/bup/master/scripts/install.sh' | bash  # (1)!

iex (iwr -useb 'https://raw.githubusercontent.com/smashedr/bup/master/scripts/install.ps1').Content  # (1)!

go install github.com/smashedr/bup@latest  # (1)!

docker run --rm -itv ~/bin:/out ghcr.io/smashedr/ir:latest -b /out smashedr/bup  # (1)!

Windows users can download the Windows Installer.exe.
Alternatively, you can manually download a release.

Remembers your destination directory and uses the current directory as source by default.

Supports directory excludes stored in the config file with the saved destination.

To get started check out the Features, Install the app and view the Usage.

If you run into any issues or have any questions, support is available.

Demo¶

This demo was generated with charmbracelet/vhs.

Features¶

• Backup a source directory to a destination
• Will save and reuse the destination
• Use the current directory for source
• Uses saved directory excludes
• Creates a timestamped archive
• Puts archives in named directory

Install¶

brew install cssnr/tap/bup

curl 'https://raw.githubusercontent.com/smashedr/bup/master/scripts/install.sh' | bash  # (1)!

iex (iwr -useb 'https://raw.githubusercontent.com/smashedr/bup/master/scripts/install.ps1').Content  # (1)!

go install github.com/smashedr/bup@latest  # (1)!

docker run --rm -itv ~/bin:/out ghcr.io/smashedr/ir:latest -b /out smashedr/bup  # (1)!

Windows users can download the Windows Installer.exe.
Alternatively, you can manually download a release.

Usage¶

Specify source and destination.

bup [source] [destination]

Use --list to list backups.

bup -l [name]

Use --info to prints the configuration.

bup -i

Use --edit to open the config in an editor.

bup -e