summaryrefslogtreecommitdiff
path: root/doc/git-annex-get.mdwn
blob: 7faa5fd57f090c259a9db9bededde24256eb6506 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# NAME

git-annex get - make content of annexed files available

# SYNOPSIS

git annex get `[path ...]`

# DESCRIPTION

Makes the content of annexed files available in this repository. This
will involve copying them from a remote repository, or downloading them,
or transferring them from some kind of key-value store.

# OPTIONS

* `--auto`

  Rather than getting all files, get only files that don't yet have
  the desired number of copies, or that are preferred content of the
  repository. See [[git-annex-preferred-content]](1)

* `--from=remote`

  Normally git-annex will choose which remotes to get the content
  from. Use this option to specify which remote to use. 
  
  Any files that are not available on the remote will be silently skipped.

* `--jobs=N` `-JN`

  Enables parallel download with up to the specified number of jobs
  running at once. For example: `-J10`

* `--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.

* file matching options
 
  The [[git-annex-matching-options]](1)
  can be used to specify files to get.

* `--all`

  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.

* `--unused`

  Operate on files found by last run of git-annex unused.

* `--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 is not an annexed file, a blank line is output in response instead.

  Since the usual progress output while getting a file is verbose and not
  machine-parseable, you may want to use --json in combination with
  --batch.

* `--json`

  Enable JSON output. This is intended to be parsed by programs that use
  git-annex. Each line of output is a JSON object.

# SEE ALSO

[[git-annex]](1)

[[git-annex-drop]](1)

[[git-annex-copy]](1)

[[git-annex-move]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.