1datalad siblings(1) General Commands Manual datalad siblings(1)
2
6 datalad siblings - manage sibling configuration
7
9 datalad siblings [-h] [-d DATASET] [-s NAME] [--url [URL]]
10 [--pushurl PUSHURL] [-D DESCRIPTION] [--fetch] [--as-common-
11 datasrc NAME] [--publish-depends SIBLINGNAME] [--publish-by-
12 default REFSPEC] [--annex-wanted EXPR] [--annex-required EXPR]
13 [--annex-group EXPR] [--annex-groupwanted EXPR] [--inherit]
14 [--no-annex-info] [-r] [-R LEVELS] [--version]
15 [{query|add|remove|configure|enable}]
16
20 This command offers four different actions: 'query', 'add', 'remove',
21 information about (all) known siblings. 'add' and 'configure' are high‐
22 ly similar actions, the only difference being that adding a sibling
23 with a name that is already registered will fail, whereas re-configur‐
24 ing a (different) sibling under a known name will not be considered an
25 error. 'enable' can be used to complete access configuration for
26 non-Git sibling (aka git-annex special remotes). Lastly, the 'remove'
27 action allows for the removal (or de-configuration) of a registered
28 sibling.
29 For each sibling (added, configured, or queried) all known sibling
31 properties are reported. This includes:
32 "name"
34 Name of the sibling
35 "path"
37 Absolute path of the dataset
38 "url"
40 For regular siblings at minimum a "fetch" URL, possibly also a
41 "pushurl"
42 Additionally, any further configuration will also be reported using a
44 key that matches that in the Git configuration.
45 By default, sibling information is rendered as one line per sibling
47 following this scheme::
48 <dataset_path>: <sibling_name>(<+|->) [<access_specification]
50 where the `+` and `-` labels indicate the presence or absence of a re‐
52 mote data annex at a particular remote, and ACCESS_SPECIFICATION con‐
53 tains either a URL and/or a type label for the sibling.
54
56 {query|add|remove|configure|enable}
57 command action selection (see general documentation). Con‐
58 straints: value must be one of ('query', 'add', 'remove', 'con‐
59 figure', 'enable') [Default: 'query']
60 -h, --help, --help-np
63 show this help message. --help-np forcefully disables the use of
64 a pager for displaying the help message
65 -d DATASET, --dataset DATASET
67 specify the dataset to configure. If no dataset is given, an at‐
68 tempt is made to identify the dataset based on the input and/or
69 the current working directory. Constraints: Value must be a
70 Dataset or a valid identifier of a Dataset (e.g. a path) or val‐
71 ue must be NONE
72 -s NAME, --name NAME
74 name of the sibling. For addition with path "URLs" and sibling
75 removal this option is mandatory, otherwise the hostname part of
76 a given URL is used as a default. This option can be used to
77 limit 'query' to a specific sibling. Constraints: value must be
78 a string or value must be NONE
79 --url [URL]
81 the URL of or path to the dataset sibling named by NAME. For re‐
82 cursive operation it is required that a template string for
83 building subdataset sibling URLs is given. List of currently
84 available placeholders: %NAME the name of the dataset, where
85 slashes are replaced by dashes. Constraints: value must be a
86 string or value must be NONE
87 --pushurl PUSHURL
89 in case the URL cannot be used to publish to the dataset sib‐
90 ling, this option specifies a URL to be used instead. If no
91 `url` is given, PUSHURL serves as `url` as well. Constraints:
92 value must be a string or value must be NONE
93 -D DESCRIPTION, --description DESCRIPTION
95 short description to use for a dataset location. Its primary
96 purpose is to help humans to identify a dataset copy (e.g.,
97 "mike's dataset on lab server"). Note that when a dataset is
98 published, this information becomes available on the remote
99 side. Constraints: value must be a string or value must be NONE
100 --fetch
102 fetch the sibling after configuration.
103 --as-common-datasrc NAME
105 configure a sibling as a common data source of the dataset that
106 can be automatically used by all consumers of the dataset. The
107 sibling must be a regular Git remote with a configured HTTP(S)
108 URL.
109 --publish-depends SIBLINGNAME
111 add a dependency such that the given existing sibling is always
112 published prior to the new sibling. This equals setting a con‐
113 figuration item 'remote.SIBLINGNAME.datalad-publish-depends'.
114 This option can be given more than once to configure multiple
115 dependencies. Constraints: value must be a string or value must
116 be NONE
117 --publish-by-default REFSPEC
119 add a refspec to be published to this sibling by default if
120 nothing specified. Constraints: value must be a string or value
121 must be NONE
122 --annex-wanted EXPR
124 expression to specify 'wanted' content for the repository/sib‐
125 ling. See https://git-annex.branchable.com/git-annex-wanted/ for
126 more information. Constraints: value must be a string or value
127 must be NONE
128 --annex-required EXPR
130 expression to specify 'required' content for the repository/sib‐
131 ling. See https://git-annex.branchable.com/git-annex-required/
132 for more information. Constraints: value must be a string or
133 value must be NONE
134 --annex-group EXPR
136 expression to specify a group for the repository. See
137 https://git-annex.branchable.com/git-annex-group/ for more in‐
138 formation. Constraints: value must be a string or value must be
139 NONE
140 --annex-groupwanted EXPR
142 expression for the groupwanted. Makes sense only if --annex-
143 wanted="groupwanted" and annex-group is given too. See
144 https://git-annex.branchable.com/git-annex-groupwanted/ for more
145 information. Constraints: value must be a string or value must
146 be NONE
147 --inherit
149 if sibling is missing, inherit settings (git config, git annex
150 wanted/group/groupwanted) from its super-dataset.
151 --no-annex-info
153 Whether to query all information about the annex configurations
154 of siblings. Can be disabled if speed is a concern.
155 -r, --recursive
157 if set, recurse into potential subdatasets.
158 -R LEVELS, --recursion-limit LEVELS
160 limit recursion into subdatasets to the given number of levels.
161 Constraints: value must be convertible to type 'int' or value
162 must be NONE
163 --version
165 show the module and its version which provides the command
166
168 datalad is developed by The DataLad Team and Contributors <team@datal‐
169 ad.org>.
170datalad siblings 0.19.3 2023-08-11 datalad siblings(1)