datalad export-archive

Synopsis

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

Description

Export the content of a dataset as a TAR/ZIP archive.

Options

PATH

File name of the generated TAR archive. If no file name is given the archive will be generated in the current directory and will be named: datalad_<dataset_uuid>.(tar.*|zip). To generate that file in a different directory, provide an existing directory as the file name. Constraints: value must be a string [Default: None]

-h, –help, –help-np

show this help message. –help-np forcefully disables the use of a pager for displaying the help message

-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)

-t tar|zip, –archivetype tar|zip

Type of archive to generate. Constraints: value must be a string [Default: ‘tar’]

-c gz|bz2|, –compression gz|bz2|

Compression method to use. ‘bz2’ is not supported for ZIP archives. No compression is used when an empty string is given. Constraints: value must be a string [Default: ‘gz’]

–missing-content error|continue|ignore

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 a string [Default: ‘error’]

Authors

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