DATALAD-EXPORT-ARCHIVE(1)

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

💅 datalad export-archive — bestie's guide to yeeting your dataset into a TAR/ZIP ✨

Okay so picture this: it's a General Commands Manual entry, the name is datalad export-archive, and its whole personality is "export the content of a dataset as a TAR/ZIP archive." That's it, that's the vibe. 🎀

✨ NAME ✨

datalad export-archive — literally exports the content of a dataset as a TAR/ZIP archive. no cap, that's the entire job. 🗂️

🌸 SYNOPSIS 🌸

datalad export-archive [-h] [-d DATASET] [-t {tar|zip}] [-c {gz|bz2|}]
       [--missing-content {error|continue|ignore}] [--version] [PATH]

🦋 OPTIONS 🦋

okay bestie, read these carefully — some of them change what happens when stuff is missing and that's highkey important 💀
  • PATH — the file name of the generated TAR archive. If you don't hand over a file name, the archive gets made right in the current directory and it's called: datalad_<dataset_uuid>.(tar.*|zip). Wanna drop that file somewhere else? Then give an existing directory as the file name and it'll live there instead. 🫶 Constraints: value must be a string or value must be NONE.
  • -h, --help, --help-np — show this help message. --help-np forcefully disables the use of a pager for displaying the help message (so no, you won't get trapped in less, you're welcome 💅).
  • -d DATASET, --dataset DATASET — specify the dataset to export. 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.
  • -t {tar|zip}, --archivetype {tar|zip} — the type of archive to generate. Constraints: value must be one of ('tar', 'zip') [Default: 'tar']. 🎁
  • -c {gz|bz2|}, --compression {gz|bz2|} — compression method to use. Heads up: 'bz2' is not supported for ZIP archives 😭. No compression is used when an empty string is given. Constraints: value must be one of ('gz', 'bz2', '') [Default: 'gz'].
  • --missing-content {error|continue|ignore} — okay so by default, any discovered file with missing content will result in an error and the export is aborted. 😳 Setting this to 'continue' will issue warnings instead of failing on error. The value 'ignore' will only inform about problem at the 'debug' log level. The latter two can be helpful when generating a TAR archive from a dataset where some file content is not available locally. Constraints: value must be one of ('error', 'continue', 'ignore') [Default: 'error'].
  • --version — show the module and its version which provides the command. slay, version info 👑

👑 AUTHORS 👑

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

and that's a wrap, bestie 💖 this page is from datalad export-archive 1.1.5, dated 2025-06-15, and it goes by datalad export-archive(1) — go forth and archive responsibly ✨🎀

📦 where this page comes from