borg-config(1)

💅 borg-config — get, set, and delete values in a repository or cache config file

okay bestie, welcome to borg-config(1) from the borg backup tool — she's a tiny little command with main character energy and she's about to let you poke at config files directly. 🎀

---

✨ SYNOPSIS ✨

borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]

like, that's the whole vibe. short. iconic. slays. 👑

---

🦋 DESCRIPTION 🦋

so basically this command gets and sets options in a local repository or cache config file. 💖

For security reasons, this command only works on local repositories. no remote shenanigans, sorry babe, it's ✨ local only ✨.

here's the tea on how to use her:

• wanna delete a config value entirely? use --delete.
• wanna list the values of the configuration file, or the default values? use --list. 📋
• wanna get an existing key? just pass the key name, nothing else.
• wanna set a key? pass both the key name and the new value. periodt.

keys can be written in the format "section.name" or just plain "name" — and when you don't give a section, it defaults to "repository" for the repo config and "cache" for the cache config. lowkey convenient, highkey true. 💅

and by default, borg config manipulates the repository config file. if you wanna edit the repository cache's config file instead, hit her with --cache. 🧚

---

🌸 OPTIONS 🌸

btw check borg-common(1) for the common options of Borg commands — those are shared with all the other borg girlies. 🫶

🍓 arguments

• REPOSITORY — the repository you're configuring, bestie. that's the one.
• NAME — the name of the config key. just the name.
• VALUE — the new value for the key. the glow-up you're applying to it. ✨

💜 options

• -c, --cache — get and set values from the repo cache instead. cache mode activated. 🌈
• -d, --delete — delete the key from the config file. bye bestie, gone, no notes. 💀
• -l, --list — list the configuration of the repo. show me everything. 👀

---

🔥 EXAMPLES 🔥

Note: the repository & cache config files are some of the only directly manipulable parts of a repository that aren't versioned or backed up, so be careful when making changes! 😭 fr fr, no undo, no safety net, no cap.

find the cache directory:

# find cache directory
$ cd ~/.cache/borg/$(borg config /path/to/repo id)

reserve some space:

# reserve some space
$ borg config /path/to/repo additional_free_space 2G

make a repo append-only:

# make a repo append-only
$ borg config /path/to/repo append_only 1

set storage quota to 50 GB:

# set storage quota to 50 GB
$ borg config /path/to/repo storage_quota 50G

set maximum segment size to 100 MiB (see "Adjusting segment size" in Usage Notes):

# set maximum segment size to 100 MiB (see "Adjusting segment size" in Usage Notes)
$ borg config /path/to/repo max_segment_size 104857600

ate. every single one. 🔥

---

👑 SEE ALSO 👑

borg-common(1)

iykyk. 💖

---

🎀 Author 🎀

The Borg Collective

---

and that's the whole page, bestie!! 🦋 this diva is borg-config(1) from the borg backup tool, and she was written by The Borg Collective, dated 2026-07-18. go forth and configure responsibly, mwah 💅✨🌸