git-annex-pull(1)

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

🦋 git-annex-pull — the manual page, bestie edition 🦋

okay so you're reading the git-annex-pull(1) page from the General Commands Manual and honestly? it's a good one. let's get into it 💅

✨ NAME ✨

git-annex-pull — pull content from remotes. that's it. that's the vibe 🫶

✨ SYNOPSIS ✨

git annex pull [remote ...]

✨ DESCRIPTION ✨

so this command pulls content from remotes, no cap. it downloads both git repository content AND the content of annexed files. and like git pull, it merges changes into the current branch. main character energy fr 🔥

you could just run git pull and git-annex get by hand to do the same thing, but this command handles a bunch of details for you — including making sure the git-annex branch actually gets fetched from the remote. lowkey iconic of it 💖

some special remotes contain a tree of files that can be imported, and this command can pull from those remotes as well as from regular git remotes. see git-annex-import(1) for the whole breakdown on how those special remotes work. but heads up bestie: in order for this command to import from a special remote, remote.<name>.annex-tracking-branch also has to be configured, and it must have the same value as the currently checked out branch. yes that's specific. yes it matters 🙈

when git-annex-adjust(1) has been used to check out an adjusted branch, this command will also pull changes from the parent branch. cute 🌸

when git-annex-view(1) has been used to check out a view branch, this command updates the view branch to reflect any changes to the parent branch or metadata. slay ✨

when git-annex-migrate(1) has been used in other repositories, this updates the content in the local repository for those migrations as well. teamwork 💜

normally this tries to download the content of each annexed file, from any remote that it's pulling from that has a copy. to control which files it downloads, configure the preferred content of the local repository. it will also drop files from the local repository that are not preferred content. see git-annex-preferred-content(1). so yeah, it giveth and it taketh away 😭

✨ OPTIONS ✨

  • [remote] — by default this command pulls from all available remotes, except for remotes that have remote.<name>.annex-pull (or remote.<name>.annex-sync) set to false. by naming remotes (or remote groups), you control which ones it pulls from. you're the boss 👑
  • --fast — only pull with the remotes that have the lowest annex-cost value configured. when you give it a list of remotes (or remote groups), it picks from among those; otherwise it picks from among all remotes. speedrun strats 🏃‍♀️
  • --only-annex, -a, --not-only-annex — only pull the git-annex branch and annexed content from remotes, not other git branches. the annex.synconlyannex configuration can be set to true to make this the default behavior — and to override such a setting, use --not-only-annex. when this is combined with --no-content, only the git-annex branch will be pulled. minimalism 💅
  • --no-content, -g, --content — use --no-content or -g to avoid downloading (and dropping) the content of annexed files, and also prevent doing any migrations of content. if you often use --no-content, you can set the annex.synccontent configuration to false to prevent downloading content by default — the --content option overrides that configuration. and to only prevent migrations of content, you can set the annex.syncmigrations configuration to false — the --content option overrides that configuration as well. so many layers, we love a config queen 🎀
  • --content-of=path, -C path — only download (and drop) annexed files in the given path. this option can be repeated multiple times with different paths. picky and we respect it 🦋
  • --all, -A — usually this command operates on annexed files in the current branch. this option makes it operate on all available versions of all annexed files (when preferred content settings allow). note that preferred content settings that use include= or exclude= will only match the version of files currently in the work tree, but not past versions of files. ⚠️ read that twice bestie
  • --jobs=N, -JN — enables parallel pulling with up to the specified number of jobs running at once. for example: -J10. setting this to "cpus" will run one job per CPU core. (note that git pulls are not done in parallel because that tends to be less efficient.) multitasking icon 🔥
  • --allow-unrelated-histories, --no-allow-unrelated-histories — passed on to git merge, to control whether or not to merge histories that do not share a common ancestor. drama resolution settings 😌
  • --resolvemerge, --no-resolvemerge — by default, merge conflicts are automatically handled by this command. when two conflicting versions of a file have been committed, both will be added to the tree, under different filenames. for example, file "foo" would be replaced with "foo.variant-A" and "foo.variant-B". (see git-annex-resolvemerge(1) for details.) use --no-resolvemerge to disable this automatic merge conflict resolution — it can also be disabled by setting annex.resolvemerge to false. no fighting on my watch 🤝
  • --backend — specifies which key-value backend to use when importing from a special remote. 🧚

also the git-annex-common-options(1) can be used. free real estate ✨

✨ SEE ALSO ✨

go read those too, iykyk 📚

✨ AUTHOR ✨

Joey Hess <id@joeyh.name> — the legend themselves 👑💖

and that's the page!! this whole thing is git-annex-pull(1) from the General Commands Manual, and yeah the footer really is just git-annex-pull(1) again — consider this your cute little sign-off, bestie 🌈⭐ go pull something great 🫶

📦 where this page comes from