Scroll to navigation

datalad(1) General Commands Manual datalad(1)


datalad - comprehensive data management solution


datalad [-l LEVEL] [--pbs-runner {condor}] [-C PATH] [--version] [--dbg] [--idbg] [-c KEY=VALUE] [-f {default,json,json_pp,tailored,'<template>'}] [--report-status {success,failure,ok,notneeded,impossible,error}] [--report-type {dataset,file}] [--on-failure {ignore,continue,stop}] [--cmd] [-h] COMMAND ...


DataLad provides a unified data distribution system built on the Git and Git-annex. DataLad command line tools allow to manipulate (obtain, create, update, publish, etc.) datasets and provide a comprehensive toolbox for joint management of data and code. Compared to Git/annex it primarly extends their functionality to transparently and simultaneously work with multiple inter-related repositories.


{create, install, get, publish, push, uninstall, drop, remove, update, create-sibling, create-sibling-github, create-sibling-gitlab, create-sibling-ria, unlock, save, copy-file, search, metadata, aggregate-metadata, extract-metadata, wtf, test, ls, clean, add-archive-content, download-url, run, rerun, run-procedure, export-archive-ora, no-annex, export-to-figshare, export-archive, check-dates, addurls, add-readme, annotate-paths, clone, create-test-dataset, status, diff, siblings, sshrun, subdatasets}

-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
run as if datalad was started in <path> instead of the current working directory. When multiple -C options are given, each subsequent non-absolute -C <path> is interpreted relative to the preceding -C <path>. This option affects the interpretations of the path names in that they are made relative to the working directory caused by the -C option
show the program's version
enter Python debugger when uncaught exception happens
enter IPython debugger when uncaught exception happens
configuration variable setting. Overrides any configuration read from a file, but is potentially overridden itself by configuration variables in the process environment.
-f {default, json, json_pp, tailored,'<template>'}, --output-format {default, json, json_pp, tailored,'<template>'}
select format for returned command results. 'default' give one line per result reporting action, status, path and an optional message; 'json' renders a JSON object with all properties for each result (one per line); 'json_pp' pretty-prints JSON spanning multiple lines; 'tailored' enables a command-specific rendering style that is typically tailored to human consumption (no result output otherwise), '<template>' reports any value(s) of any result properties in any format indicated by the template (e.g. '{path}'; compare with JSON output for all key-value choices). The template syntax follows the Python "format() language". It is possible to report individual dictionary values, e.g. '{metadata[name]}'. If a 2nd-level key contains a colon, e.g. 'music:Genre', ':' must be substituted by '#' in the template, like so: '{metadata[music#Genre]}'.
--report-status {success, failure, ok, notneeded, impossible, error}
constrain command result report to records matching the given status. 'success' is a synonym for 'ok' OR 'notneeded', 'failure' stands for 'impossible' OR 'error'.
--report-type {dataset, file}
constrain command result report to records matching the given type. Can be given more than once to match multiple types.
--on-failure {ignore, continue, stop}
when an operation fails: 'ignore' and continue with remaining operations, the error is logged but does not lead to a non-zero exit code of the command; 'continue' works like 'ignore', but an error causes a non-zero exit code; 'stop' halts on first failure and yields non-zero exit code. A failure is any result with status 'impossible' or 'error'.
syntactical helper that can be used to end the list of global command line options before the subcommand label. Options taking an arbitrary number of arguments may require to be followed by a single --cmd in order to enable identification of the subcommand.
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message

"Be happy!"


datalad is developed by The DataLad Team and Contributors <>.
2021-02-04 datalad 0.14.0