DATALAD-WTF(1)

📦
version 1.1.5 · 8 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

🎀 datalad wtf(1) 🎀

okay so this is a page from the General Commands Manual (yes, capital letters, very official ✨) and it's all about datalad wtf — bestie, the name is sending me but it's genuinely such a useful little command 💅

🌸 NAME 🌸

datalad wtf — generates a whole report about your DataLad installation and configuration 🫶 like a vibe check for your setup, no cap

✨ SYNOPSIS ✨

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

💖 DESCRIPTION 💖

IMPORTANT: sharing this report with untrusted parties (e.g. on the web) should be done with care, because it may include identifying information, and/or credentials or access tokens. 😭 so like… be careful who you send this to, fr fr. it's giving "screenshot your whole settings page and post it" energy and we are NOT doing that.

🦋 OPTIONS 🦋

  • -h, --help, --help-np — show this help message. and --help-np forcefully disables the use of a pager for displaying the help message (so it just prints straight to your terminal, no paging drama 🙈)
  • -d DATASET, --dataset DATASET — specify the dataset to report on. if 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) or value must be NONE 💫
  • -s {some|all}, --sensitive {some|all} — 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') 🔥
  • -S SECTION, --section SECTION — section to include. if not set — depends on flavor. '*' could be used to force all sections. if there are subsections like section.subsection available, then specifying just 'section' would select all subsections for that section. this option can be given multiple times 👑 constraints: value must be one of ('configuration', 'credentials', 'datalad', 'dataset', 'dependencies', 'environment', 'extensions', 'git-annex', 'location', 'metadata', 'metadata.extractors', 'metadata.filters', 'metadata.indexers', 'python', 'system', '*')
  • --flavor {full|short} — flavor of WTF 😭 (yes that's the real name of the option, iconic). 'full' would produce markdown with an exhaustive list of sections. 'short' will provide a condensed summary only of datalad and dependencies by default — use --section to list other sections. constraints: value must be one of ('full', 'short') [Default: 'full'] ⭐
  • -D {html_details}, --decor {html_details} — decoration around the rendering to facilitate embedding into issues etc, e.g. use 'html_details' for posting collapsible entry to GitHub issues 💅 constraints: value must be one of ('html_details',)
  • -c, --clipboard — if set, do not print but copy to clipboard (requires pyperclip module). 🍓 ngl this one is lowkey the main character
  • --version — show the module and its version which provides the command 🌈

🧚 AUTHORS 🧚

datalad is developed by The DataLad Team and Contributors <team@datalad.org>. 🫶 absolute legends, we stan

and that's the whole page bestie!! 💜 this one's from datalad wtf version 1.1.5, dated 2025-06-15 — go read your own setup report and slay ✨🎀💅

📦 where this page comes from