https://github.com/smashedr/bup
Back UP CLI written in Go. Easily backup a directory with saved excludes and destination.
https://github.com/smashedr/bup
cli golang
Last synced: 4 months ago
JSON representation
Back UP CLI written in Go. Easily backup a directory with saved excludes and destination.
- Host: GitHub
- URL: https://github.com/smashedr/bup
- Owner: smashedr
- License: mit
- Created: 2026-01-19T23:44:18.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2026-02-05T06:48:08.000Z (4 months ago)
- Last Synced: 2026-02-05T14:47:38.189Z (4 months ago)
- Topics: cli, golang
- Language: Go
- Homepage: https://smashedr.github.io/bup/
- Size: 113 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: docs/support.md
Awesome Lists containing this project
README
[](https://github.com/smashedr/bup/releases)
[](https://github.com/smashedr/bup/releases/latest)
[](https://github.com/smashedr/bup/blob/master/go.mod)
[](https://github.com/smashedr/bup/deployments/docs)
[](https://github.com/smashedr/bup/deployments/preview)
[](https://github.com/smashedr/bup/actions/workflows/release.yaml)
[](https://github.com/smashedr/bup/actions/workflows/lint.yaml)
[](https://github.com/smashedr/bup/pulse)
[](https://github.com/smashedr/bup?tab=readme-ov-file#readme)
[](https://github.com/smashedr/bup?tab=readme-ov-file#readme)
[](https://github.com/smashedr/bup/graphs/contributors)
[](https://github.com/smashedr/bup/issues)
[](https://github.com/smashedr/bup/discussions)
[](https://github.com/smashedr/bup/forks)
[](https://github.com/smashedr/bup/stargazers)
[](https://cssnr.github.io/)
[](https://discord.gg/wXy6m2X8wY)
[](https://ko-fi.com/cssnr)
# Back UP
[](#homebrew)
[](#bash)
[](#powershell)
[](#source)
[](#docker)
[](https://github.com/smashedr/bup/releases/latest/download/bup_Windows_Installer.exe)
- [Install](#install)
- [Usage](#usage)
- [Development](#development)
- [Support](#Support)
- [Contributing](#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.
[](https://smashedr.github.io/bup/)
## Install
[](https://github.com/smashedr/bup/releases)
[](https://github.com/smashedr/bup/releases/latest/download/bup_Windows_Installer.exe)
#### Homebrew
```shell
brew install cssnr/tap/bup
```
#### Bash
```shell
curl https://i.jpillora.com/smashedr/bup! | bash
```
💾 Alternatively, you can manually [download a release](https://github.com/smashedr/bup/releases).
#### PowerShell
```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](https://github.com/smashedr/bup/releases/latest/download/bup_Windows_Installer.exe).
#### Source
```shell
go install github.com/smashedr/bup@latest
```
#### Docker
```shell
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._
[](https://smashedr.github.io/bup/)
## Usage
Specify `source` and `destination`.
```shell
bup [source] [destination]
```
Use `--list` to list backups.
```shell
bup -l [name]
```
Use `--info` to prints the configuration.
```shell
bup -i
```
Use `--edit` to open the config in an editor.
```shell
bup -e
```
[](https://smashedr.github.io/bup/)
# Development
Go:
```shell
go run main.go
```
Task:
```shell
task build
task lint
```
Docs:
```shell
task docs
```
Inno Setup:
```shell
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:
- Q&A Discussion:
- Request a Feature:
- Chat with us on Discord:
[](https://github.com/smashedr/bup/issues/new?template=1-feature.yaml)
[](https://github.com/smashedr/bup/issues)
[](https://github.com/smashedr/bup/discussions)
[](https://discord.gg/wXy6m2X8wY)
# Contributing
If you would like to submit a PR, please review the [CONTRIBUTING.md](#contributing-ov-file).
Please consider making a donation to support the development of this project
and [additional](https://cssnr.com/) open source projects.
[](https://ko-fi.com/cssnr)
For a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)