git-annex-fromkey(1)

git-annex-fromkey1

Adds a file using a specific key

Usage

git annex fromkey [key file ...]

Overview

This plumbing-level command can be used to manually set up a file in the git repository to link to a specified key.

Multiple pairs of file and key can be given in a single command line.

If no key and file pair are specified on the command line, batch input is used, the same as if the --batch option were specified.

Normally the key is a git-annex formatted key. However, to make it easier to use this to add urls, if the key cannot be parsed as a key, and is a valid url, an URL key is constructed from the url. Note that this does not register the url as a location of the key; use git-annex-registerurl(1) to do that.

Options

--force

Allow making a file link to a key whose content is not in the local repository. The key may not be known to git-annex at all.

--batch

In batch input mode, lines are read from stdin, and each line should contain a key and filename, separated by a single space.

-z

When in batch mode, the input is delimited by nulls instead of the usual newlines.

(Note that for this to be used, you have to explicitly enable batch mode with --batch)

--json

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

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

Releases

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

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

--batch since Debian 10 (Buster); --json since Debian 11 (Bullseye); -z since Debian 10 (Buster).

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.