git-annex-required(1)

git-annex-required1

Get or set required content expression

Usage

git annex required repository [expression]

Overview

When run with an expression, configures the content that is required to be held in the repository.

Without an expression, displays the current required content setting of the repository.

While git-annex-wanted(1) is just a preference, this designates content that should really not be removed. 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.

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.

Releases

6 releases since Debian 9 (Stretch); the text changed 3 times.

  1. 9
  2. 10–11
  3. 12
  4. 13–Arch

Author

Joey Hess <[email protected]>

From git-annex 10.20261026-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.