SYNOPSIS¶

DESCRIPTION¶

This results in the files within archive (which should be under annex
control itself) added under annex referencing original archive via
custom special remotes mechanism

Example:

annex-repo$ datalad add-archive-content my_big_tarball.tar.gz

OPTIONS¶

--version show the program's version and license information -h, --help, --help-np show this help message. --help-np forcefully disables the use of a pager for displaying the help message -l LEVEL, --log-level LEVEL set logging verbosity level. Choose among critical, error, warning, info, debug. Also you can specify an integer <10 to provide even more debugging information -p {condor}, --pbs-runner {condor} execute command by scheduling it via available PBS. For settings, config file will be consulted --annex ANNEX annex instance to use. [Default: None] --add-archive-leading-dir flag to place extracted content under a directory which would correspond to archive name with suffix stripped. E.g. for archive EXAMPLE.ZIP its content will be extracted under a directory EXAMPLE/. [Default: False] --strip-leading-dirs flag to move all files directories up, from how they were stored in an archive, if that one contained a number (possibly more than 1 down) single leading directories. [Default: False] --leading-dirs-depth LEADING_DIRS_DEPTH maximal depth to strip leading directories to. If not specified (None), no limit. [Default: None] --leading-dirs-consider LEADING_DIRS_CONSIDER regular expression(s) for directories to consider to strip away. Constraints: value must be a string [Default: None] --use-current-dir flag to extract archive under the current directory, not the directory where archive is located. Note that it will be of no effect if --key is given. [Default: False] -d, --delete flag to delete original archive from the filesystem/git in current tree. Note that it will be of no effect if --key is given. [Default: False] --key flag to signal if provided archive is not actually a filename on its own but an annex key. [Default: False] -e EXCLUDE, --exclude EXCLUDE regular expressions for filenames which to exclude from being added to annex. Applied after --rename if that one is specified. For exact matching, use anchoring. Constraints: value must be a string [Default: None] -r RENAME, --rename RENAME regular expressions to rename files before being added under git. First letter defines how to split provided string into two parts: Python regular expression (with groups), and replacement string. Constraints: value must be a string [Default: None] --existing {fail,overwrite,archive-suffix,numeric-suffix} what operation to perform a file from archive tries to overwrite an existing file with the same name. 'fail' (default) leads to RuntimeError exception. 'overwrite' silently replaces existing file. 'archive-suffix' instructs to add a suffix (prefixed with a '-') matching archive name from which file gets extracted, and if that one present, 'numeric-suffix' is in effect in addition, when incremental numeric suffix (prefixed with a '.') is added until no name collision is longer detected. [Default: 'fail'] -o ANNEX_OPTIONS, --annex-options ANNEX_OPTIONS additional options to pass to git-annex. Constraints: value must be a string [Default: None] --copy flag to copy the content of the archive instead of moving. [Default: False] --no-commit flag to not commit upon completion. [Default: True] --allow-dirty flag that operating on a dirty repository (uncommitted or untracked content) is ok. [Default: False] --stats STATS ActivityStats instance for global tracking. [Default: None] --drop-after drop extracted files after adding to annex. [Default: False] --delete-after extract under a temporary directory, git-annex add, and delete after. To be used to "index" files within annex without actually creating corresponding files under git. Note that `annex dropunused` would later remove that load. [Default: False]

AUTHORS¶