tldr/pages/common/borg.md

borg

Deduplicating backup tool. Creates local or remote backups that are mountable as filesystems. More information: https://borgbackup.readthedocs.io/en/stable/usage/general.html.

• Initialise a (local) repository:

borg init {{/path/to/repo_directory}}

• Backup a directory into the repository, creating an archive called "Monday":

borg create --progress {{/path/to/repo_directory}}::{{Monday}} {{/path/to/source_directory}}

• List all archives in a repository:

borg list {{/path/to/repo_directory}}

• Extract a specific directory from the "Monday" archive in a remote repository, excluding all *.ext files:

borg extract {{user}}@{{host}}:{{/path/to/repo_directory}}::{{Monday}} {{path/to/target_directory}} --exclude '{{*.ext}}'

• Prune a repository by deleting all archives older than 7 days, listing changes:

borg prune --keep-within {{7d}} --list {{/path/to/repo_directory}}

• Mount a repository as a FUSE filesystem:

borg mount {{/path/to/repo_directory}}::{{Monday}} {{/path/to/mountpoint}}

• Display help on creating archives:

borg create --help