git-annex-fromkey(1)

✨ git-annex-fromkey ✨

okay bestie, welcome to the git-annex-fromkey manual page, part of the git-annex fam 💖 this one lives in the General Commands Manual section and it's giving very specific, very plumbing-core energy.

🌸 NAME 🌸

git-annex-fromkey — adds a file using a specific key 🎀

🦋 SYNOPSIS 🦋

git annex fromkey [key file ...]

💅 DESCRIPTION 💅

so like. this is a plumbing-level command, which is code for "you're down in the pipes, bestie, and you know exactly what you're doing." 🫶

It lets you manually set up a file in the git repository to link to a specified key. that's the whole vibe. you got a key, you got a file, you're introducing them. matchmaker era. 💖

And you're not limited to one glow-up at a time — you can hand over multiple pairs of file and key in a single command line. slay.

If you don't specify any key and file pair on the command line at all? no problem. batch input is used, exactly the same as if you'd typed --batch yourself. it just knows. ✨

Now, normally that key is a git-annex formatted key. BUT — and this is the cute little shortcut — to make it easier to use this for adding urls, if the key cannot be parsed as a key, and it is a valid url, then an URL key is constructed from the url. convenient!

⚠️ heads up though: this does NOT register the url as a location of the key. if that's what you want, go use git-annex-registerurl(1) instead. this command is not doing that for you, bestie, no matter how nicely you ask. 💀

🎀 OPTIONS 🎀

• --force — lets you make a file link to a key whose content is not in the local repository. and like, the key might not even be known to git-annex at all. chaotic, but permitted. 🔥
• --batch — batch input mode! lines get read from stdin, and each line should have a key and filename, separated by a single space. one space. just the one. 🫶
• -z — when you're in batch mode, this makes the input delimited by nulls instead of the usual newlines.

🙈 note note note: for this to actually be used, you have to explicitly enable batch mode with --batch. -z alone is not gonna do it, babes.

• --json — turns on JSON output. this is intended to be parsed by programs that use git-annex. each line of output is a JSON object. machine-readable realness. 🤖✨

Also, the git-annex-common-options(1) can be used too. those are always invited to the party. 🎉

👑 SEE ALSO 👑

• git-annex(1)

💜 AUTHOR 💜

Joey Hess <id@joeyh.name> — the icon, the moment, the legend. 🫶

and that's the whole page, bestie!! this was git-annex-fromkey(1) from the git-annex source, and yeah the footer is literally just the same page name again, iconic behavior honestly. go forth and link your keys. periodt. 💅✨🎀