git-annex-verifyremote(1)

📦 version 10.20261026, in alpine 3.24, arch rolling, debian trixie

💖 git-annex-verifyremote(1) 💖

okay so bestie, welcome to the General Commands Manual page for git-annex-verifyremote — this is the vibe check for your special remotes. yes, really. it's giving "trust but verify" but make it git. 🌸

✨ NAME ✨

git-annex-verifyremote — verify if a special remote is safe to use

🦋 SYNOPSIS 🦋

git annex verifyremote name [--safe ID|--unsafe]

👑 DESCRIPTION 👑

so here's the sitch. when a special remote was created by someone else (not you, not your bestie, just some person out there in the world), it's super important to verify that the repository it's configured to use is actually in the location you expect. because if it's not? 😭 you risk information leaking out from the special remote to other remotes. that's the data leakage jumpscare and we are NOT doing that.

to prevent such data leakage, git-annex enableremote will display the configuration of the special remote, and prompt you to run this command. and until the special remote is verified, it cannot be used. no cap. it's locked. 🔒

now, when a special remote is autoenabled by git-annex init, it can be used before it is verified. but — and this is the important but — git-annex will prevent sending annexed files or git pushes to any remote, until this command is used to verify the autoenabled special remote. so like, it's on probation. 🙈

this command can also be used when the configuration of a special remote has changed. and ngl, the old configuration will continue to be used until this command is used to verify the new configuration. out with the old, in with the new, but only after the vibe check. 💅

when run with no options, this command displays the configuration of the special remote, and prompts you to verify it. that's the standard mode, the lil "hey look at this, is it right?" moment. 🥺

🎀 OPTIONS 🎀

  • --safe ID — use this when you have verified that the configuration of the special remote makes it use the location you expect. slay. ✅
    • the ID will be provided to you by git-annex when displaying the configuration of the special remote. it literally hands you the receipt, you just gotta hand it back. 🧾
  • --unsafe — if the configuration of the special remote makes it use a location that you did not expect, use this option. red flag detected bestie, we're calling it out. 🚩

also, the git-annex-common-options(1) can be used. the classics, they always work. 💜

🌈 SEE ALSO 🌈

💅 AUTHOR 💅

Joey Hess <id@joeyh.name>

lowkey reminder bestie: this command is the moment you decide whether a special remote is a green flag or a red flag. read the configuration, verify the location, then pick your option. don't skip the vibe check. ✨

and that's the whole page, fr fr 🫶 this one's from the git-annex-verifyremote(1) page, dated and versioned under git-annex-verifyremote(1) in the General Commands Manual — go verify those remotes, main character. ⭐🎀🦋

📦 where this page comes from