git-annex-required(1)

✨ NAME ✨

git-annex-required — bestie, this is how you get or set the required content expression 💖

---

🌸 SYNOPSIS 🌸

git annex required repository [expression]

---

🎀 DESCRIPTION 🎀

Okay so, when you run this with an expression, it configures the content that is required to be held in the repository. Periodt.

Run it with no expression and it just tells you the current required content setting of the repository. Like a little vibe check for your repo 👑

Now here's the tea: git-annex-wanted(1) is just a preference, lowkey. But this? This designates content that should really not be removed. Fr fr. For example, a file that is wanted can be removed with git annex drop, but if that file is required, it would need to be removed with git annex drop --force. 😭

Also, git-annex fsck will warn about required contents that are not present. So like, it will notice. Not me being the main character of your repo's guilt trip 💀

For example:

git annex required here "include=*.mp3 or include=*.ogg"

To return a repository to the original default behavior, use an empty value for the expression, eg:

git-annex required here ""

---

💅 OPTIONS 💅

• The git-annex-common-options(1) can be used.

---

🌈 NOTES 🌈

• The required command was added in git-annex 5.20150420.

---

🦋 SEE ALSO 🦋

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

---

👑 AUTHOR 👑

Joey Hess <id@joeyh.name>

---

And that's the whole page, bestie — this is from the General Commands Manual, page git-annex-required(1), and no, there's no fancy date or version stamped down here, just the manual name doing its little walk-off. Slay 💖✨