git-annex-findkeys(1)

💖 git-annex-findkeys 💖

okay bestie, so this is the git-annex-findkeys page from the General Commands Manual — it's the little command that spills the tea on every key git-annex knows about 🫖✨

---

✨ NAME ✨

git-annex-findkeys — lists available keys

---

🌸 SYNOPSIS 🌸

git annex findkeys

---

🦋 DESCRIPTION 🦋

It outputs a list of keys known to git-annex. That's it. That's the whole vibe. a whole roster of keys, served fresh 💅

---

👑 OPTIONS 👑

🌈 matching options 🌈

The git-annex-matching-options(1) can be used to specify which keys to list.

By default, the findkeys command only lists keys whose content is currently present. Specifying any of the matching options will override this default behavior and match on all keys that git-annex knows about. so the second you add a matching option, the default just steps aside, no cap 👀

• To list all keys, present or not, specify --anything.
• To list keys whose content is not present, specify --not --in=here

---

• --print0 — Output keys terminated with nulls, for use with xargs -0
• --format=value — Use custom output formatting.

The value is a format string, in which '${var}' is expanded to the value of a variable. To right-justify a variable with whitespace, use '${var;width}' ; to left-justify a variable, use '${var;-width}'; to escape unusual characters (including control characters) in a variable, use '${escaped_var}'

These variables are available for use in formats: key, backend, bytesize, humansize, keyname, hashdirlower, hashdirmixed, mtime (for the mtime field of a WORM key).

Also, '\n' is a newline, '\000' is a NULL, etc.

The default output format is the same as --format='${escapedkey}\n' except when outputting to a terminal, control characters will be escaped. so like, same fit, but the terminal version gets a lil makeover 🎀

• --json — Output the list of keys in JSON format.

This is intended to be parsed by programs that use git-annex. Each line of output is a JSON object. one object per line, so your scripts can just go brrr 🧚

• --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. yes queen, those apply too 💚

---

💜 SEE ALSO 💜

• git-annex(1)
• git-annex-find(1)

---

⭐ AUTHOR ⭐

Joey Hess <id@joeyh.name>

---

okay that's the whole page, you ate that 💅✨

mwah 💖 this was git-annex-findkeys(1) from the General Commands Manual — version/date stamped right there in the page footer, same as always, so you know it's the real one, periodt 🎀