Scroll to navigation

datalad-add-sibling(1) General Commands Manual datalad-add-sibling(1)

SYNOPSIS

datalad-add-sibling [--version] [-h] [-l LEVEL] [--pbs-runner {condor}] [-s NAME] [--dataset DATASET] [--pushurl PUSHURL] [-r] [--fetch] [--force] [--as-common-datasrc NAME] [--publish-depends SIBLINGNAME] [--publish-by-default REFSPEC] [--annex-wanted EXP] [--annex-group GROUP] [--annex-groupwanted EXPR] [--inherit] [url]

DESCRIPTION

Add a sibling to a dataset.

OPTIONS

url
the URL of or path to the dataset sibling named by NAME. If you want to recursively add siblings, it is expected, that you pass a template for building the URLs of the siblings of all (sub)datasets by using placeholders. List of currently available placeholders: %NAME the name of the dataset, where slashes are replaced by dashes. This option is ignored if there is already a configured sibling dataset under the name given by NAME. Constraints: value must be a string [Default: None]

--version
show the program's version and license information
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-l LEVEL, --log-level LEVEL
set logging verbosity level. Choose among critical, error, warning, info, debug. Also you can specify an integer <10 to provide even more debugging information
--pbs-runner {condor}
execute command by scheduling it via available PBS. For settings, config file will be consulted
-s NAME, --name NAME
name of the sibling to be added. If RECURSIVE is set, the same name will be used to address the subdatasets' siblings. Constraints: value must be a string [Default: None]
--dataset DATASET, -d DATASET
specify the dataset to add the sibling to. If no dataset is given, an attempt is made to identify the dataset based on the current working directory. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) [Default: None]
--pushurl PUSHURL
in case the URL cannot be used to publish to the dataset sibling, this option specifies a URL to be used instead. If no URL is given, PUSHURL serves as URL as well. This option is ignored if there is already a configured sibling dataset under the name given by NAME. Constraints: value must be a string [Default: None]
-r, --recursive
if set, recurse into potential subdataset. [Default: False]
--fetch
fetch the sibling after adding. [Default: False]
--force, -f
if sibling NAME exists already, force to (re-)configure its URLs. [Default: False]
--as-common-datasrc NAME
configure the created sibling as a common data source of the dataset that can be automatically used by all consumers of the dataset (technical: git-annex auto-enabled special remote). [Default: None]
--publish-depends SIBLINGNAME
add a dependency such that the given existing sibling is always published prior to the new sibling. This equals setting a configuration item 'remote.SIBLINGNAME.datalad-publish-depends'. This option can be given more than once to configure multiple dependencies. Constraints: value must be a string [Default: None]
--publish-by-default REFSPEC
add a refspec to be published to this sibling by default if nothing specified. Constraints: value must be a string [Default: None]
--annex-wanted EXP
expression to specify 'wanted' content for the repository/sibling. See https://git-annex.branchable.com/git-annex-wanted/ for more information. Constraints: value must be a string [Default: None]
--annex-group GROUP
expression to specify a group for the repository. See https://git-annex.branchable.com/git-annex-group/ for more information. Constraints: value must be a string [Default: None]
--annex-groupwanted EXPR
expression for the groupwanted. Makes sense only if --annex-wanted="groupwanted" and annex-group is given too. See https://git-annex.branchable.com/git-annex-groupwanted/ for more information. Constraints: value must be a string [Default: None]
--inherit
if sibling is missing, inherit settings (git config, git annex wanted/group/groupwanted) from its super-dataset. [Default: False]

AUTHORS

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.
2017-03-25 datalad-add-sibling 0.5.1