1datalad wtf(1)              General Commands Manual             datalad wtf(1)
2
3
4

NAME

6       datalad wtf - generate a report about the DataLad installation and con‐
7       figuration
8

SYNOPSIS

10       datalad  wtf  [-h]  [-d   DATASET]   [-s   {some|all}]   [-S   SECTION]
11              [--flavor {full|short}] [-D {html_details}] [-c] [--version]
12
13
14

DESCRIPTION

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

OPTIONS

21       -h, --help, --help-np
22              show this help message. --help-np forcefully disables the use of
23              a pager for displaying the help message
24
25       -d DATASET, --dataset DATASET
26              "specify the dataset to report on. no dataset is given,  an  at‐
27              tempt is made to identify the dataset based on the current work‐
28              ing directory. Constraints: Value must be a Dataset or  a  valid
29              identifier of a Dataset (e.g. a path) or value must be NONE
30
31       -s {some|all}, --sensitive {some|all}
32              if set to 'some' or 'all', it will display sections such as con‐
33              fig and metadata which could potentially contain  sensitive  in‐
34              formation  (credentials,  names,  etc.).  If  'some', the fields
35              which are known to be sensitive will still be masked  out.  Con‐
36              straints: value must be one of ('some', 'all')
37
38       -S SECTION, --section SECTION
39              section to include. If not set - depends on flavor. '*' could be
40              used to force all sections. If there are subsections  like  sec‐
41              tion.subsection  available, then specifying just 'section' would
42              select all subsections for that section. This option can be giv‐
43              en  multiple times. Constraints: value must be one of ('configu‐
44              ration', 'credentials',  'datalad',  'dataset',  'dependencies',
45              'environment',  'extensions',  'git-annex', 'location', 'metada‐
46              ta', 'metadata.extractors', 'metadata.filters', 'metadata.index‐
47              ers', 'python', 'system', '*')
48
49       --flavor {full|short}
50              Flavor  of  WTF.  'full'  would produce markdown with exhaustive
51              list of sections. 'short' will provide a condensed summary  only
52              of  datalad  and  dependencies by default. Use --section to list
53              other sections. Constraints:  value  must  be  one  of  ('full',
54              'short') [Default: 'full']
55
56       -D {html_details}, --decor {html_details}
57              decoration around the rendering to facilitate embedding into is‐
58              sues etc, e.g. use 'html_details' for posting collapsible  entry
59              to  GitHub  issues. Constraints: value must be one of ('html_de‐
60              tails',)
61
62       -c, --clipboard
63              if set, do not print but copy to clipboard  (requires  pyperclip
64              module).
65
66       --version
67              show the module and its version which provides the command
68

AUTHORS

70        datalad is developed by The DataLad Team and Contributors <team@datal‐
71       ad.org>.
72
73
74
75datalad wtf 0.19.3                2023-08-11                    datalad wtf(1)
Impressum