borgfs(1)

📦
version 2.0.0b25 · 5 versions
, in ubuntu stonking

💅 borgfs(1) — like, the mount-y one 🦋

okay bestie, welcome to borgfs from the borg backup tool family. this is the page in your manual for it. grab a strawberry drink 🍓 and let's go.

✨ Name ✨

borgfs — Mounts an archive or an entire repository as a FUSE filesystem.

no cap, that's literally the whole job: it takes your archive (or your whole repo) and makes it look like a normal folder you can walk around in. it's giving filesystem but make it borg 💖

🌸 SYNOPSIS 🌸

borgfs [options] [REPOSITORY] MOUNTPOINT [PATH...]

🎀 DESCRIPTION 🎀

For more information, see borg mount --help.

yep, that's it. borgfs is the little sibling of borg mount, so all the real tea lives over in that help output. go read it, i'll wait 🫶

👑 OPTIONS 👑

See borg-common(1) for common options of Borg commands. (those are the shared ones every borg command gets, not just us 💜)

🌈 arguments 🌈

  • REPOSITORY — the repository you wanna mount. default: as given by -r/--repo or BORG_REPO.
  • MOUNTPOINT — where to mount the filesystem. the spot. the venue. the location 💅
  • PATH — paths to extract; patterns are supported. so you can be picky about which bits you pull out ✨

💖 options 💖

  • -V, --version — show version number and exit. quick lil flex then bounce.
  • -f, --foreground — stay in foreground, do not daemonize. so it just... hangs out with you instead of sneaking off into the background 👀
  • -o — extra mount options.
  • --numeric-ids — use numeric user and group identifiers from archives. no name translation, just the raw numbers, periodt.

🔥 Archive filters 🔥

  • -a PATTERN, --match-archives PATTERN — only consider archives matching all patterns. See borg help match-archives. (yes, all of them — it's an AND situation, not an OR one 🧚)
  • --sort-by KEYS — Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp. pick your main character ordering ⭐
  • --first N — consider the first N archives after other filters are applied.
  • --last N — consider the last N archives after other filters are applied.
  • --oldest TIMESPAN — consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
  • --newest TIMESPAN — consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g., 7d or 12m.
  • --older TIMESPAN — consider archives older than (now - TIMESPAN), e.g., 7d or 12m.
  • --newer TIMESPAN — consider archives newer than (now - TIMESPAN), e.g., 7d or 12m.

the way those filters all take TIMESPANs like 7d and 12m?? obsessed 😭

🦋 Include/Exclude options 🦋

  • -e PATTERN, --exclude PATTERN — exclude paths matching PATTERN. not invited to the party, bestie 🚫
  • --exclude-from EXCLUDEFILE — read exclude patterns from EXCLUDEFILE, one per line.
  • --pattern PATTERN — include/exclude paths matching PATTERN.
  • --patterns-from PATTERNFILE — read include/exclude patterns from PATTERNFILE, one per line.
  • --strip-components NUMBER — Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. so they just... don't show up. no drama, no error, just gone 🙈
heads up: "silently skipped" means silently. no warnings, no crying, they're just not there. don't come for me when a path goes missing 💀

🌟 SEE ALSO 🌟

💜 Author 💜

The Borg Collective

and that's the whole page, you ate it up fr fr 🎀 go mount something iconic 👑

borg backup tool — this page is dated 2026-10-07, mwah 💋

📦 where this page comes from