git-annex-sync(1)

📦
version 10.20261026 · 5 versions
, in alpine 3.24, arch rolling

💅 git-annex-sync — the group-chat rundown

okay so this is git-annex-sync(1) from the General Commands Manual — yes bestie, the same big git-annex manual family you already know and love 🫶 — and it's literally the page that teaches you how to make your local repo and its remotes, like, actually get on the same page. Let's go ✨

🌸 NAME 🌸

git-annex-sync — synchronize local repository with remotes 💖

🎀 SYNOPSIS 🎀

git annex sync [remote ...]

✨ DESCRIPTION ✨

This command synchronizes the local repository with its remotes. That's it, that's the vibe check 🦋

Here's the tea on the order of operations, because the order matters: it first commits any local changes to files that have previously been added to the repository. Then it does the equivalent of git-annex-pull(1) followed by git-annex-push(1). So: commit, pull, push. In that order, no skipping, no cap 🔥

Now for the ✨special case✨ that you need to know about. Unlike push and pull, this command defaults to avoiding transferring the content of annexed files to repositories that do not have preferred content configured. Yep — a whole special case, and the reason is to avoid a surprising behavior change. Using any option or configuration that enables content syncing — including --content, --content-of, and setting annex.synccontent — will avoid this special case. So the moment you opt into content, the special case dips and you get the normal content-tastic behavior 💫

🌈 OPTIONS 🌈

  • --no-content, -g, --content — use --no-content or -g to avoid transferring the content of annexed files.

If you often use --no-content, you can set the annex.synccontent configuration to false to prevent transferring content by default. The --content option overrides that configuration. So like, set it and forget it, but --content is the main character that can override it whenever it wants 👑

  • --content-of=path, -C path — only pull and push the content of annexed files in the given path.

This option can be repeated multiple times with different paths. Go off, list as many paths as your heart desires 🍓

Heads up bestie: this option does not prevent exporting other files to an "exporttree=yes" remote. So don't come for it later, it warned you 💀
  • --commit, --no-commit — a commit is done by default (unless annex.autocommit is set to false).

Use --no-commit to avoid committing local changes.

  • --message=msg, -m msg — use this option to specify a commit message. Very demure, very mindful of your git history 💅

If multiple -m options are given, their values are concatenated as separate paragraphs. Cute, right? Multiple -ms stack up like little paragraphs of lore 📝

  • --pull, --no-pull — use this option to disable pulling.
Real talk: when remote.<name>.annex-sync is set to false, pulling is disabled for that remote, and using --pull will not enable it. So don't be out here thinking --pull is a magic undo button, because it is not 🙈
  • --push, --no-push — use this option to disable pushing.
Same energy: when remote.<name>.annex-sync is set to false, pushing is disabled for that remote, and using --push will not enable it. Periodt 💯

🦋 SEE ALSO 🦋

👑 AUTHOR 👑

Joey Hess <id@joeyh.name> — the legend himself, we stan 🌟

okay that's the whole page, you're officially synced and slaying 💜 this was git-annex-sync(1) from the General Commands Manual (the manual name is folded up there at the top like a little bow 🎀) — mwah, go sync something, ily, bye 💖🌸

📦 where this page comes from