Back UP

• Install
• Usage
• Development
• Support
• Contributing

Back UP 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.

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.

Install

Homebrew

brew install cssnr/tap/bup

Bash

curl https://i.jpillora.com/smashedr/bup! | bash

💾 Alternatively, you can manually download a release.

PowerShell

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

🪟 Windows users can download the Windows Installer.exe.

Source

go install github.com/smashedr/bup@latest

Docker

docker run --rm -itv ~/bin:/out ghcr.io/smashedr/ir:latest -b /out smashedr/bup

Note: Docker requires you to mount the target bin directory.

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

Development

Go: https://go.dev/doc/install

go run main.go

Task: https://taskfile.dev/docs/installation

task build
task lint

Docs: https://zensical.org/docs/get-started

task docs

Inno Setup: https://jrsoftware.org/isdl.php

task pathmgr
task inno

Support

If you run into any issues or need help getting started, please do one of the following:

• Report an Issue: https://github.com/smashedr/bup/issues
• Q&A Discussion: https://github.com/smashedr/bup/discussions/categories/q-a
• Request a Feature: https://github.com/smashedr/bup/issues/new?template=1-feature.yaml
• Chat with us on Discord: https://discord.gg/wXy6m2X8wY

Contributing

If you would like to submit a PR, please review the CONTRIBUTING.md.

Please consider making a donation to support the development of this project and additional open source projects.

For a full list of current projects visit: https://cssnr.github.io/