1datalad(1) General Commands Manual datalad(1)
2
6 datalad - comprehensive data management solution
7
9 datalad [-c (:name|name=value)] [-C PATH] [--cmd] [-l LEVEL] [--on-
10 failure {ignore,continue,stop}] [--report-status
11 {success,failure,ok,notneeded,impossible,error}] [--report-type
12 {dataset,file}] [-f
13 {generic,json,json_pp,tailored,disabled,'<template>'}] [--dbg]
14 [--idbg] [--version] COMMAND ...
15
19 DataLad provides a unified data distribution system built on the Git
20 and Git-annex. DataLad command line tools allow to manipulate (obtain,
21 create, update, publish, etc.) datasets and provide a comprehensive
22 toolbox for joint management of data and code. Compared to Git/annex it
23 primarily extends their functionality to transparently and simultane‐
24 ously work with multiple inter-related repositories.
25
27 {create-sibling-github, create-sibling-gitlab, create-sibling-gogs,
28 create-sibling-gin, create-sibling-gitea, create-sibling-ria, create-
29 sibling, siblings, update, subdatasets, drop, remove, addurls, copy-
30 file, download-url, foreach-dataset, install, rerun, run-procedure,
31 create, save, status, clone, get, push, run, diff, configuration, wtf,
32 clean, add-archive-content, add-readme, export-archive, export-archive-
33 ora, export-to-figshare, no-annex, check-dates, unlock, uninstall, cre‐
34 ate-test-dataset, sshrun, shell-completion}
35 -c (:name|name=value)
38 specify configuration setting overrides. They override any con‐
39 figuration read from a file. A configuration can also be unset
40 temporarily by prefixing its name with a colon (':'), e.g. ':us‐
41 er.name'. Overrides specified here may be overridden themselves
42 by configuration settings declared as environment variables.
43 -C PATH
45 run as if datalad was started in <path> instead of the current
46 working directory. When multiple -C options are given, each sub‐
47 sequent non-absolute -C <path> is interpreted relative to the
48 preceding -C <path>. This option affects the interpretations of
49 the path names in that they are made relative to the working di‐
50 rectory caused by the -C option
51 --cmd syntactical helper that can be used to end the list of global
53 command line options before the subcommand label. Options taking
54 an arbitrary number of arguments may require to be followed by a
55 single --cmd in order to enable identification of the subcom‐
56 mand.
57 -l LEVEL, --log-level LEVEL
59 set logging verbosity level. Choose among critical, error, warn‐
60 ing, info, debug. Also you can specify an integer <10 to provide
61 even more debugging information
62 --on-failure {ignore, continue, stop}
64 when an operation fails: 'ignore' and continue with remaining
65 operations, the error is logged but does not lead to a non-zero
66 exit code of the command; 'continue' works like 'ignore', but an
67 error causes a non-zero exit code; 'stop' halts on first failure
68 and yields non-zero exit code. A failure is any result with sta‐
69 tus 'impossible' or 'error'. [Default: 'continue', but individu‐
70 al commands may define an alternative default]
71 --report-status {success, failure, ok, notneeded, impossible, error}
73 constrain command result report to records matching the given
74 status. 'success' is a synonym for 'ok' OR 'notneeded', 'fail‐
75 ure' stands for 'impossible' OR 'error'.
76 --report-type {dataset, file}
78 constrain command result report to records matching the given
79 type. Can be given more than once to match multiple types.
80 -f {generic, json, json_pp, tailored, disabled,'<template>'}, --output-
82 format {generic, json, json_pp, tailored, disabled,'<template>'}
83 select rendering mode command results. 'tailored' enables a com‐
84 mand-specific rendering style that is typically tailored to hu‐
85 man consumption, if there is one for a specific command, or oth‐
86 erwise falls back on the the 'generic' result renderer; 'gener‐
87 ic' renders each result in one line with key info like action,
88 status, path, and an optional message); 'json' a complete JSON
89 line serialization of the full result record; 'json_pp' like
90 'json', but pretty-printed spanning multiple lines; 'disabled'
91 turns off result rendering entirely; '<template>' reports any
92 value(s) of any result properties in any format indicated by the
93 template (e.g. '{path}', compare with JSON output for all key-
94 value choices). The template syntax follows the Python "format()
95 language". It is possible to report individual dictionary val‐
96 ues, e.g. '{metadata[name]}'. If a 2nd-level key contains a
97 colon, e.g. 'music:Genre', ':' must be substituted by '#' in the
98 template, like so: '{metadata[music#Genre]}'. [Default: 'tai‐
99 lored']
100 --dbg enter Python debugger for an uncaught exception
102 --idbg enter IPython debugger for an uncaught exception
104 --version
106 show the module and its version which provides the command
107
109 datalad is developed by The DataLad Team and Contributors <team@datal‐
110 ad.org>.
111datalad 0.19.3 2023-08-11 datalad(1)