1datalad create-sibling-gogs(1G)eneral Commands Manudaaltalad create-sibling-gogs(1)
2
6 datalad create-sibling-gogs - create a dataset sibling on a GOGS site
7
9 datalad create-sibling-gogs [-h] [--api URL] [--dataset DATASET] [-r]
10 [-R LEVELS] [-s NAME]
11 [--existing {skip|error|reconfigure|replace}]
12 [--credential NAME] [--access-protocol {https|ssh|https-ssh}]
13 [--publish-depends SIBLINGNAME] [--private]
14 [--description DESCRIPTION] [--dry-run] [--version] [<org-
15 name>/]<repo-(base)name>
16
20 GOGS is a self-hosted, free and open source code hosting solution with
21 low resource demands that enable running it on inexpensive devices like
22 a Raspberry Pi, or even directly on a NAS device.
23 In order to be able to use this command, a personal access token has to
25 be generated on the platform (Account->Your Settings->Applica‐
26 tions->Generate New Token).
27 This command can be configured with "datalad.create-sibling-ghlike.ex‐
29 tra-remote-settings.NETLOC.KEY=VALUE" in order to add any local KEY =
30 VALUE configuration to the created sibling in the local `.git/config`
31 file. NETLOC is the domain of the Gogs instance to apply the configura‐
32 tion for. This leads to a behavior that is equivalent to calling data‐
33 lad's ``siblings('configure', ...)``||``siblings configure`` command
34 with the respective KEY-VALUE pair after creating the sibling. The
35 configuration, like any other, could be set at user- or system level,
36 so users do not need to add this configuration to every sibling created
37 with the service at NETLOC themselves.
38 New in version 0.16
40
42 [<org-name>/]<repo-(base)name>
43 repository name, optionally including an '<organization>/' pre‐
44 fix if the repository shall not reside under a user's namespace.
45 When operating recursively, a suffix will be appended to this
46 name for each subdataset. Constraints: value must be a string
47 -h, --help, --help-np
50 show this help message. --help-np forcefully disables the use of
51 a pager for displaying the help message
52 --api URL
54 URL of the GOGS instance without a 'api/<version>' suffix. Con‐
55 straints: value must be a string or value must be NONE
56 --dataset DATASET, -d DATASET
58 dataset to create the publication target for. If not given, an
59 attempt is made to identify the dataset based on the current
60 working directory. Constraints: Value must be a Dataset or a
61 valid identifier of a Dataset (e.g. a path) or value must be
62 NONE
63 -r, --recursive
65 if set, recurse into potential subdatasets.
66 -R LEVELS, --recursion-limit LEVELS
68 limit recursion into subdatasets to the given number of levels.
69 Constraints: value must be convertible to type 'int' or value
70 must be NONE
71 -s NAME, --name NAME
73 name of the sibling in the local dataset installation (remote
74 name). Constraints: value must be a string or value must be NONE
75 --existing {skip|error|reconfigure|replace}
77 behavior when already existing or configured siblings are dis‐
78 covered: skip the dataset ('skip'), update the configuration
79 ('reconfigure'), or fail ('error'). DEPRECATED DANGER ZONE: With
80 'replace', an existing repository will be irreversibly removed,
81 re-initialized, and the sibling (re-)configured (thus implies
82 'reconfigure'). REPLACE could lead to data loss! In interactive
83 sessions a confirmation prompt is shown, an exception is raised
84 in non-interactive sessions. The 'replace' mode will be removed
85 in a future release. Constraints: value must be one of ('skip',
86 'error', 'reconfigure', 'replace') [Default: 'error']
87 --credential NAME
89 name of the credential providing a personal access token to be
90 used for authorization. The token can be supplied via configura‐
91 tion setting 'datalad.credential.<name>.token', or environment
92 variable DATALAD_CREDENTIAL_<NAME>_TOKEN, or will be queried
93 from the active credential store using the provided name. If
94 none is provided, the host-part of the API URL is used as a name
95 (e.g. 'https://api.github.com' -> 'api.github.com'). Con‐
96 straints: value must be a string or value must be NONE
97 --access-protocol {https|ssh|https-ssh}
99 access protocol/URL to configure for the sibling. With 'https-
100 ssh' SSH will be used for write access, whereas HTTPS is used
101 for read access. Constraints: value must be one of ('https',
102 'ssh', 'https-ssh') [Default: 'https']
103 --publish-depends SIBLINGNAME
105 add a dependency such that the given existing sibling is always
106 published prior to the new sibling. This equals setting a con‐
107 figuration item 'remote.SIBLINGNAME.datalad-publish-depends'.
108 This option can be given more than once to configure multiple
109 dependencies. Constraints: value must be a string or value must
110 be NONE
111 --private
113 if set, create a private repository.
114 --description DESCRIPTION
116 Brief description, displayed on the project's page. Constraints:
117 value must be a string or value must be NONE
118 --dry-run
120 if set, no repository will be created, only tests for sibling
121 name collisions will be performed, and would-be repository names
122 are reported for all relevant datasets.
123 --version
125 show the module and its version which provides the command
126
128 datalad is developed by The DataLad Team and Contributors <team@datal‐
129 ad.org>.
130datalad create-sibling-gogs 0.19.32023-08-11 datalad create-sibling-gogs(1)