git-annex-get(1)

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

💖 git-annex-get — get content of annexed files 💖

okay so real talk, bestie: this is the git-annex-get page from the General Commands Manual, and it's about pulling the actual contents of your annexed files into this repo. Let's go. 🦋

✨ SYNOPSIS ✨

git annex get [path ...]

🌸 DESCRIPTION 🌸

So get makes the content of annexed files actually available in this repository. Like, the file is there but it's a symlink pointing at content that lives somewhere else — and get is the girl who goes and fetches it. 💅

That fetch can mean copying them from a remote repository, or downloading them, or transferring them from some kind of key-value store. Whatever the vibe, the content ends up here. 🔥

With no parameters, it gets all annexed files in the current directory whose content was not already present. And yes, you can also specify the paths of files or directories to get. 🫶

🎀 EXAMPLES 🎀

the classic "wait why is my PDF a symlink" moment:

# evince foo.pdf
error: Unable to open document foo.pdf: No such file or directory
# ls foo.pdf
foo.pdf@
# git annex get foo.pdf
get foo.pdf (from origin..) ok
# evince foo.pdf

see how foo.pdf@ is giving symlink energy? get said "not on my watch" and now evince is happy. iconic. ✨

👑 OPTIONS 👑

  • --wanted — instead of grabbing all the specified files, get only those that are preferred content of the repository. see git-annex-preferred-content(1) 💖
  • --auto — instead of grabbing all the specified files, get only the ones that don't yet have the desired number of copies, or that are preferred content of the repository.
  • --from=remote — normally git-annex picks which remotes to get the content from, preferring remotes with lower costs. use this to say exactly which remote to use. note that any files that are not available on that remote will be silently skipped (no drama, no error, just skipped 🙈).
  • --jobs=N, -JN — enables parallel download 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. when files can be downloaded from multiple remotes, enabling parallel downloads will split the load between the remotes. for example, if the files are available on remotes A and B, then one file will be downloaded from A, and another file will be downloaded from B in parallel. (remotes with lower costs are still preferred over higher cost remotes.) 😌
  • matching options — the git-annex-matching-options(1) can be used to control what to get. 👀
  • --incomplete — resume any incomplete downloads of files that were started and interrupted at some point previously. useful to pick up where you left off … when you don't quite remember where that was. 😭 these incomplete files are the same ones that are listed as unused temp files by git-annex-unused(1). note that the git-annex key will be displayed when downloading, as git-annex does not know the associated file, and the associated file may not even be in the current git working directory. 💀
  • --all, -A — rather than specifying a filename or path to get, this option can be used to get all available versions of all files. ✨ this is the default behavior when running git-annex in a bare repository.
  • --branch=ref — operate on files in the specified branch or treeish. 🌿
  • --unused — operate on files found by the last run of git annex unused.
  • --failed — operate on files that have recently failed to be transferred. 🔴 not to be confused with --incomplete, which resumes only downloads that managed to transfer part of the content of a file.
  • --key=keyname — use this option to get a specified key. 🔑
  • --batch — enables batch mode, in which lines containing names of files to get are read from stdin. 📥 as each specified file is processed, the usual progress output is displayed. if the specified file's content is already present, or it does not match specified matching options, or it is not an annexed file, a blank line is output in response instead. since the usual output while getting a file is verbose and not machine-parseable, you may want to use --json in combination with --batch. big brain move fr fr.
  • --batch-keys — this is like --batch but the lines read from stdin are parsed as keys. 🗝️
  • -z — makes batch input be delimited by nulls instead of the usual newlines.
  • --json — enable JSON output. this is intended to be parsed by programs that use git-annex. each line of output is a JSON object. 🤖
  • --json-progress — include progress objects in JSON output.
  • --json-error-messages — messages that would normally be output to standard error are included in the JSON instead.

also the git-annex-common-options(1) can be used. 💜

🦋 SEE ALSO 🦋

🌈 AUTHOR 🌈

Joey Hess <id@joeyh.name> — the main character who wrote all this, we stan 👑

aaaand that's the whole page, bestie! straight from the git-annex General Commands Manual, page git-annex-get(1). go get those files, you got this 🫶💖🎀

📦 where this page comes from