1git-annex-get(1)            General Commands Manual           git-annex-get(1)
2
3
4

NAME

6       git-annex-get - make content of annexed files available
7

SYNOPSIS

9       git annex get [path ...]
10

DESCRIPTION

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
16       With  no  parameters,  gets  all annexed files in the current directory
17       whose content was not already present. Paths of files or directories to
18       get can be specified.
19

EXAMPLES

21        # evince foo.pdf
22        error: Unable to open document foo.pdf: No such file or directory
23        # ls foo.pdf
24        foo.pdf@
25        # git annex get foo.pdf
26        get foo.pdf (from origin..) ok
27        # evince foo.pdf
28

OPTIONS

30       --auto
31
32              Rather than getting all the specified files, get only those that
33              don't yet have the desired number of copies, or  that  are  pre‐
34              ferred  content  of the repository. See git-annex-preferred-con‐
35              tent(1)
36
37       --from=remote
38              Normally git-annex will choose which remotes to get the  content
39              from,  preferring  remotes  with lower costs. Use this option to
40              specify which remote to use.
41
42              Any files that are not available on the remote will be  silently
43              skipped.
44
45       --jobs=N -JN
46              Enables  parallel  download  with  up to the specified number of
47              jobs running at once. For example: -J10
48
49              Setting this to "cpus" will run one job per CPU core.
50
51              When files can be downloaded  from  multiple  remotes,  enabling
52              parallel  downloads will split the load between the remotes. For
53              example, if the files are available on remotes A and B, then one
54              file  will  be downloaded from A, and another file will be down‐
55              loaded from B in parallel. (Remotes with lower costs  are  still
56              preferred over higher cost remotes.)
57
58       matching options
59              The git-annex-matching-options(1) can be used to control what to
60              get.
61
62       --incomplete
63              Resume any incomplete downloads of files that were  started  and
64              interrupted  at  some  point previously. Useful to pick up where
65              you left off ... when you don't quite remember where that was.
66
67              These incomplete files are the same ones that are listed as  un‐
68              used temp files by git-annex-unused(1).
69
70              Note  that the git-annex key will be displayed when downloading,
71              as git-annex does not know the associated file, and the  associ‐
72              ated file may not even be in the current git working directory.
73
74       --all -A
75              Rather  than  specifying  a filename or path to get, this option
76              can be used to get all available versions of all files.
77
78              This is the default behavior when running git-annex  in  a  bare
79              repository.
80
81       --branch=ref
82              Operate on files in the specified branch or treeish.
83
84       --unused
85              Operate on files found by last run of git-annex unused.
86
87       --failed
88              Operate on files that have recently failed to be transferred.
89
90              Not  to  be  confused with --incomplete which resumes only down‐
91              loads that managed to transfer part of the content of a file.
92
93       --key=keyname
94              Use this option to get a specified key.
95
96       --batch
97              Enables batch mode, in which lines containing names of files  to
98              get are read from stdin.
99
100              As  each  specified file is processed, the usual progress output
101              is  displayed.  If  the  specified  file's  content  is  already
102              present,  or it does not match specified matching options, or it
103              is not an annexed file, a blank line is output in  response  in‐
104              stead.
105
106              Since  the  usual output while getting a file is verbose and not
107              machine-parseable, you may want to  use  --json  in  combination
108              with --batch.
109
110       --batch-keys
111              This is like --batch but the lines read from stdin are parsed as
112              keys.
113
114       -z     Makes batch input be delimited by nulls  instead  of  the  usual
115              newlines.
116
117       --json Enable  JSON  output.  This is intended to be parsed by programs
118              that use git-annex. Each line of output is a JSON object.
119
120       --json-progress
121              Include progress objects in JSON output.
122
123       --json-error-messages
124              Messages that would normally be output to standard error are in‐
125              cluded in the json instead.
126
127       Also the git-annex-common-options(1) can be used.
128

SEE ALSO

130       git-annex(1)
131
132       git-annex-drop(1)
133
134       git-annex-copy(1)
135
136       git-annex-move(1)
137

AUTHOR

139       Joey Hess <id@joeyh.name>
140
141                                                              git-annex-get(1)