git-annex-describe(1)

git-annex-describe1

Change description of a repository

Usage

git annex describe repository description

Overview

Changes the description of a repository.

The repository to describe can be specified by git remote name or by uuid. To change the description of the current repository, use "here".

Repository descriptions are displayed by git-annex in various places. They are most useful when git-annex knows about a repository, but there is no git remote corresponding to it.

Options

--json

Enable JSON output. This is intended to be parsed by programs that use git-annex. Each line of output is a JSON object.

--json-error-messages

Messages that would normally be output to standard error are included in the JSON instead.

Also the git-annex-common-options(1) can be used.

Releases

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

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

--json since Debian 13 (Trixie); --json-error-messages since Debian 13 (Trixie).

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.