1datalad push(1) General Commands Manual datalad push(1)
2
6 datalad push - push a dataset to a known sibling.
7
9 datalad push [-h] [-d DATASET] [--to SIBLING] [--since SINCE] [--data
10 {anything|nothing|auto|auto-if-wanted}]
11 [-f {all|gitpush|checkdatapresent}] [-r] [-R LEVELS] [-J NJOBS]
12 [--version] [PATH ...]
13
17 This makes a saved state of a dataset available to a sibling or special
18 remote data store of a dataset. Any target sibling must already exist
19 and be known to the dataset.
20 By default, all files tracked in the last saved state (of the current
22 branch) will be copied to the target location. Optionally, it is possi‐
23 ble to limit a push to changes relative to a particular point in the
24 version history of a dataset (e.g. a release tag) using the --since op‐
25 tion in conjunction with the specification of a reference dataset. In
26 recursive mode subdatasets will also be evaluated, and only those sub‐
27 datasets are pushed where a change was recorded that is reflected in
28 the current state of the top-level reference dataset.
29 NOTE Power-user info: This command uses git push, and git annex copy
31 to push a dataset. Publication targets are either configured re‐
32 mote Git repositories, or git-annex special remotes (if they
33 support data upload).
34
36 PATH path to constrain a push to. If given, only data or changes for
37 those paths are considered for a push. Constraints: value must
38 be a string or value must be NONE
39 -h, --help, --help-np
42 show this help message. --help-np forcefully disables the use of
43 a pager for displaying the help message
44 -d DATASET, --dataset DATASET
46 specify the dataset to push. Constraints: Value must be a
47 Dataset or a valid identifier of a Dataset (e.g. a path) or val‐
48 ue must be NONE
49 --to SIBLING
51 name of the target sibling. If no name is given an attempt is
52 made to identify the target based on the dataset's configuration
53 (i.e. a configured tracking branch, or a single sibling that is
54 configured for push). Constraints: value must be a string or
55 value must be NONE
56 --since SINCE
58 specifies commit-ish (tag, shasum, etc.) from which to look for
59 changes to decide whether pushing is necessary. If '^' is given,
60 the last state of the current branch at the sibling is taken as
61 a starting point. Constraints: value must be a string or value
62 must be NONE
63 --data {anything|nothing|auto|auto-if-wanted}
65 what to do with (annex'ed) data. 'anything' would cause transfer
66 of all annexed content, 'nothing' would avoid call to `git annex
67 copy` altogether. 'auto' would use 'git annex copy' with '--au‐
68 to' thus transferring only data which would satisfy "wanted" or
69 "numcopies" settings for the remote (thus "nothing" otherwise).
70 'auto-if-wanted' would enable '--auto' mode only if there is a
71 "wanted" setting for the remote, and transfer 'anything' other‐
72 wise. Constraints: value must be one of ('anything', 'nothing',
73 'auto', 'auto-if-wanted') [Default: 'auto-if-wanted']
74 -f {all|gitpush|checkdatapresent}, --force {all|gitpush|checkdatapre‐
76 sent}
77 force particular operations, possibly overruling safety protec‐
78 tions or optimizations: use --force with git-push ('gitpush');
79 do not use --fast with git-annex copy ('checkdatapresent'); com‐
80 bine all force modes ('all'). Constraints: value must be one of
81 ('all', 'gitpush', 'checkdatapresent')
82 -r, --recursive
84 if set, recurse into potential subdatasets.
85 -R LEVELS, --recursion-limit LEVELS
87 limit recursion into subdatasets to the given number of levels.
88 Constraints: value must be convertible to type 'int' or value
89 must be NONE
90 -J NJOBS, --jobs NJOBS
92 how many parallel jobs (where possible) to use. "auto" corre‐
93 sponds to the number defined by 'datalad.runtime.max-annex-jobs'
94 configuration item NOTE: This option can only parallelize input
95 retrieval (get) and output recording (save). DataLad does NOT
96 parallelize your scripts for you. Constraints: value must be
97 convertible to type 'int' or value must be NONE or value must be
98 one of ('auto',)
99 --version
101 show the module and its version which provides the command
102
104 datalad is developed by The DataLad Team and Contributors <team@datal‐
105 ad.org>.
106datalad push 0.19.3 2023-08-11 datalad push(1)