DATALAD-ADD-README(1)

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

✨ datalad add-readme(1) ✨

okay bestie, so this is the datalad add-readme page from the General Commands Manual — it's the little glow-up that gives your DataLad dataset a README so people actually know what they're looking at 🎀

🌸 NAME 🌸

datalad add-readme — adds the basic info about your DataLad datasets into a README file 💅

🦋 SYNOPSIS 🦋

datalad add-readme [-h] [-d DATASET] [--existing {skip|append|replace}]
       [--version] [PATH]

💖 DESCRIPTION 💖

So here's the vibe: the README file gets added to the dataset, and then — this is the important part — the addition is saved in the dataset. Like, actually committed. Not just vibing in your working tree. ✨

⚠️ Note: Make sure that no unsaved modifications to your dataset's

(yes, the manual literally cuts off there 😭 that's exactly how it's written in the original, so I'm not gonna invent the rest for you — go check your dataset for unsaved changes before running this, iykyk 🙈)

🎀 OPTIONS 🎀

  • PATH — where the README file lives within the dataset. Constraints: value must be a string. Default: 'README.md' 🍓
  • -h, --help, --help-np — shows this help message. And --help-np forcefully disables the use of a pager for displaying the help message (so no, it won't trap you in less, bestie 💀).
  • -d DATASET, --dataset DATASET — the dataset you want to add info to. If you don't give one, it'll try to figure out the dataset from your 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.
  • --existing {skip|append|replace} — how to react if a file with the target name is already there, and yes there are exactly three moods:
    • 'skip' — do nothing 🫶
    • 'append' — append the information to the existing file
    • 'replace' — replace the existing file with new content 🔥

Constraints: value must be one of ('skip', 'append', 'replace'). Default: 'skip'.

  • --version — shows the module and its version which provides the command ⭐

🌈 AUTHORS 🌈

datalad is developed by The DataLad Team and Contributors <team@datalad.org>. 🫶

okay and the lil sign-off at the bottom — this page is for datalad add-readme 1.1.5, dated 2025-06-15, and it's the datalad add-readme(1) manual page 💜 go read some READMEs, main character 🧚‍♀️

📦 where this page comes from