DATALAD-UNLOCK(1)

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

💅 datalad unlock — the manual page, but make it make sense

okay so bestie, welcome to datalad unlock(1) from the General Commands Manual — this is the command that unlocks file(s) of a dataset. yes, that's the whole vibe. let's get into it 🫶

✨ NAME ✨

datalad unlock — unlock file(s) of a dataset

🌸 SYNOPSIS 🌸

datalad unlock [-h] [-d DATASET] [-r] [-R LEVELS] [--version] [path ...]

🦋 DESCRIPTION 🦋

so the whole point: this unlocks files of a dataset so you can actually edit the actual content. like, the real bytes. no cap, that's it, that's the job.

🎀 Examples 🎀

unlock a single file, lowkey iconic behaviour:

% datalad unlock <path/to/file>

unlock all the contents in the dataset — main character energy, go off:

% datalad unlock .

👑 OPTIONS 👑

  • path — the file(s) to unlock. Constraints, and listen closely: value must be a string or value must be NONE. that's the rule, periodt.
  • -h, --help, --help-np — show this help message. and --help-np forcefully disables the use of a pager for displaying the help message — like, it will not be paged, don't even try it 💅
  • -d DATASET, --dataset DATASET — specify the dataset to unlock files in. 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.
  • -r, --recursive — if set, recurse into potential subdatasets. yes, go deeper 🌀
  • -R LEVELS, --recursion-limit LEVELS — limit recursion into subdatasets to the given number of levels. don't let it run wild fr. Constraints: value must be convertible to type 'int' or value must be NONE.
  • --version — show the module and its version which provides the command. the receipts, basically 🧾

🌈 AUTHORS 🌈

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

ngl that's the whole page — no hidden lore, no surprise flags. go unlock your files and slay 💖

and that's a wrap, bestie: this was datalad unlock 1.1.5, dated 2025-06-15 — same facts, way better vibes. 🦋✨

📦 where this page comes from