git-annex-maxsize(1)

💖 git-annex-maxsize — the manual page, but make it a group chat 💖

okay bestie, so this is the man page for git-annex-maxsize, straight out of the General Commands Manual. It's literally the command that sets how much annexed stuff a repo is allowed to hold. Buckle up, it's short and it's iconic. ✨

🌸 NAME 🌸

git-annex-maxsize — configure maximum size of a repository. That's the whole vibe: you're telling a repo how big it's allowed to dream. 💅

🎀 SYNOPSIS 🎀

git annex maxsize repository size

git annex maxsize repository

git annex maxsize

three whole modes, pick your fighter. ✨

🦋 DESCRIPTION 🦋

So here's the tea: this configures the maximum combined size of annexed files that can be stored in a repository. Combined, bestie. All of them together. 👑

The three modes, explained with love:

• run it with a repository but no size → it shows you the maxsize that's currently configured. Just a lil peek. 👀
• run it with no parameters at all → it gives you an overview of the size and maxsize of all repositories. Like a whole census. 🌈
• run it with both → it sets the thing. main character move. 💅

Now, how do you point at a repository? You can name it by git remote name, or by uuid. And if you mean the current repository, you just say "here". Yes, literally the word. 🫶

The size? Any units you want, bestie. The page gives two examples and I'm keeping them verbatim: "100 gigabytes" or "0.8TB". Slay. 📏

⚠️ IMPORTANT CAVEAT, NO CAP: this is advisory only. It does not prevent git-annex from trying to store more data in a repository. It's a suggestion, not a bouncer. 🚫

When a repository has a preferred content expression configured using "balanced" or "sizebalanced", it will take the maxsize into account when checking preferred content. But it's still possible for the maxsize to be exceeded — for example, when there are multiple writers to the same repository. Chaos. Multiple people, one repo, nobody listening. 😭

So if you want a hard repository size limit, you have to enforce it some other way — like putting the repository on a partition of the desired size. Then you can use this command to tell git-annex about that size limit. You bring the wall, this command brings the memo. 🧱

Here's the example the page gives, and it's a good one: say a git repository is on a 1 terabyte drive, and it's the only thing stored on that drive, and annex.diskreserve is configured to 1 gigabyte — then it would make sense to run:

git-annex maxsize here "999 gigabytes"

math is mathing, bestie. 1TB minus 1GB of reserve, roughly, and you've got your number. 🔥

And to stop checking maximum size of a repository, just set the maxsize to 0. Zero. Done. Bye. ✌️

✨ OPTIONS ✨

• --bytes — displays the maximum size in bytes, which disables the default nicer units. You want the raw number? You get the raw number. 💀
• --json — enable JSON output. For the girlies piping things into other things. 🤖

also, the git-annex-common-options(1) can be used too. so many options, so little time. 🎀

👑 SEE ALSO 👑

• git-annex(1)
• git-annex-preferred-content(1)

go read those next, bestie, they're the supporting cast. 💜

🌟 AUTHOR 🌟

Joey Hess <id@joeyh.name>

the legend themselves. we love them, we thank them. 🫶

and that's the whole page!! this was git-annex-maxsize(1) from the General Commands Manual, and the footer was literally just the page name again, git-annex-maxsize(1) — no version, no date, just the name echoing back at you like a vibe check. 💅✨ go set some sizes, bestie, you've got this!! 🌸🦋💖