Scroll to navigation

datalad wtf(1) datalad datalad wtf(1)

NAME

datalad wtf - generate a report about the DataLad installation and configuration

SYNOPSIS

datalad wtf [-h] [-d DATASET] [-s SENSITIVE] [-S SECTION] [-D DECOR] [-c]

DESCRIPTION

IMPORTANT: Sharing this report with untrusted parties (e.g. on the web) should be done with care, as it may include identifying information, and/or credentials or access tokens.

OPTIONS

-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-d DATASET, --dataset DATASET
"specify the dataset to report on. 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]
-s SENSITIVE, --sensitive SENSITIVE
if set to 'some' or 'all', it will display sections such as config and metadata which could potentially contain sensitive information (credentials, names, etc.). If 'some', the fields which are known to be sensitive will still be masked out. Constraints: value must be one of ('some', 'all') [Default: None]
-S SECTION, --section SECTION
section to include. If not set, all sections. This option can be given multiple times. Constraints: value must be one of ('configuration', 'datalad', 'dataset', 'dependencies', 'environment', 'extensions', 'git-annex', 'location', 'metadata_extractors', 'system') [Default: None]
-D DECOR, --decor DECOR
decoration around the rendering to facilitate embedding into issues etc, e.g. use 'html_details' for posting collapsable entry to GitHub issues. Constraints: value must be one of ('html_details',) [Default: None]
-c, --clipboard
if set, do not print but copy to clipboard (requires pyperclip module. [Default: None]

AUTHORS

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.
2019-05-24