git-annex-registerurl(1)

📦
version 10.20261026 · 5 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

💖 git-annex-registerurl(1) — General Commands Manual 💖

okay so bestie, welcome to the git-annex-registerurl page, straight out of the General Commands Manual ✨ this one's a lil niche but it's lowkey iconic once you get it, trust.

🌸 NAME 🌸

git-annex-registerurl — it registers an url for a key, that's the whole vibe 🎀

🦋 SYNOPSIS 🦋

git annex registerurl [key url]

✨ DESCRIPTION ✨

So this is a plumbing-level command, meaning it's the gears-and-sprockets layer, not the cute porcelain stuff you'd hand to your non-Unix friends. What it does: you can use it to register urls where a key can be downloaded from 💅

⚠️ Heads up bestie: no verification is performed of the url's contents. Like, zero. None. It does not check anything. It just believes you. 🙈

Normally the key is a git-annex formatted key. But — and this is the slay part — to make it easier to use this to add urls, if the key cannot be parsed as a key, and is a valid url, a VURL key is constructed from the url. So it kinda meets you where you're at 🫶

Registering an url also makes git-annex treat the key as present in the special remote that claims it. (Usually the web special remote.) main character energy for the web remote, honestly 👑

💜 OPTIONS 💜

  • --remote=name|uuid — says hey, this url is expected to be claimed by the specified remote. And if some other remote claims the url instead? Registering it will fail. no cap, it will simply not go through 😭
Little note: --remote=web will prevent any other remote from claiming the url. web remote said "mine" and meant it 💀
  • --batch — batch input mode! Lines are read from stdin, and each line should contain a key and url, separated by a single space. 🍓

For backwards compatability with old git-annex before this option was added, when no key and url pair are specified on the command line, batch input is used, the same as if the --batch option were specified. It is however recommended to use --batch. (Yes, the old behaviour is still lurking. It's giving legacy. But bestie, just say --batch out loud, it's clearer ✨)

  • -z — when in batch mode, the input is delimited by nulls instead of the usual newlines. weird lil divider but ok, we respect it 🎀

(Note that for this to be used, you have to explicitly enable batch mode with --batch. Like, -z alone is not gonna manifest batch mode out of thin air, bestie 🧚)

  • --json — enable JSON output. This is intended to be parsed by programs that use git-annex. Each line of output is a JSON object. machine-readable slay 🤖💖
  • --json-error-messages — messages that would normally be output to standard error are included in the JSON instead. so the errors get to live inside the JSON, cozy 🌈

Also the git-annex-common-options(1) can be used. free real estate, go off 👑

🔥 SEE ALSO 🔥

the whole url-lore cinematic universe, honestly, go read them all 🌸

🌟 AUTHOR 🌟

Joey Hess <id@joeyh.name> — iconic, we stan 💜

and that's the page, bestie 🎀 this is git-annex-registerurl(1) from the git-annex manual — go forth and register those urls, you absolute legend 🦋💅

📦 where this page comes from