1git-annex-get(1) General Commands Manual git-annex-get(1)
2
6 git-annex-get - make content of annexed files available
7
9 git annex get [path ...]
10
12 Makes the content of annexed files available in this repository. This
13 will involve copying them from a remote repository, or downloading
14 them, or transferring them from some kind of key-value store.
15
17 --auto
18 Rather than getting all files, get only files that don't yet
20 have the desired number of copies, or that are preferred content
21 of the repository. See git-annex-preferred-content(1)
22 --from=remote
24 Normally git-annex will choose which remotes to get the content
25 from, preferring remotes with lower costs. Use this option to
26 specify which remote to use.
27 Any files that are not available on the remote will be silently
29 skipped.
30 --jobs=N -JN
32 Enables parallel download with up to the specified number of
33 jobs running at once. For example: -J10
34 Setting this to "cpus" will run one job per CPU core.
36 When files can be downloaded from multiple remotes, enabling
38 parallel downloads will split the load between the remotes. For
39 example, if the files are available on remotes A and B, then one
40 file will be downloaded from A, and another file will be down‐
41 loaded from B in parallel. (Remotes with lower costs are still
42 preferred over higher cost remotes.)
43 file matching options
45 The git-annex-matching-options(1) can be used to specify files
46 to get.
47 --incomplete
49 Resume any incomplete downloads of files that were started and
50 interrupted at some point previously. Useful to pick up where
51 you left off ... when you don't quite remember where that was.
52 These incomplete files are the same ones that are listed as
54 unused temp files by git-annex-unused(1).
55 Note that the git-annex key will be displayed when downloading,
57 as git-annex does not know the associated file, and the associ‐
58 ated file may not even be in the current git working directory.
59 --all -A
61 Rather than specifying a filename or path to get, this option
62 can be used to get all available versions of all files.
63 This is the default behavior when running git-annex in a bare
65 repository.
66 --branch=ref
68 Operate on files in the specified branch or treeish.
69 --unused
71 Operate on files found by last run of git-annex unused.
72 --failed
74 Operate on files that have recently failed to be transferred.
75 Not to be confused with --incomplete which resumes only down‐
77 loads that managed to transfer part of the content of a file.
78 --key=keyname
80 Use this option to get a specified key.
81 --batch
83 Enables batch mode, in which lines containing names of files to
84 get are read from stdin.
85 As each specified file is processed, the usual progress output
87 is displayed. If the specified file's content is already
88 present, or it does not match specified matching options, or it
89 is not an annexed file, a blank line is output in response
90 instead.
91 Since the usual output while getting a file is verbose and not
93 machine-parseable, you may want to use --json in combination
94 with --batch.
95 -z Makes the --batch input be delimited by nulls instead of the
97 usual newlines.
98 --json Enable JSON output. This is intended to be parsed by programs
100 that use git-annex. Each line of output is a JSON object.
101 --json-progress
103 Include progress objects in JSON output.
104 --json-error-messages
106 Messages that would normally be output to standard error are
107 included in the json instead.
108
110 git-annex(1)
111 git-annex-drop(1)
113 git-annex-copy(1)
115 git-annex-move(1)
117
119 Joey Hess <id@joeyh.name>
120 git-annex-get(1)