NAME

       datalad add-archive-content - add content of an archive under git annex control.

SYNOPSIS

       datalad  add-archive-content  [-h]  [--annex  ANNEX]  [--add-archive-leading-dir]  [--strip-leading-dirs]
              [--leading-dirs-depth LEADING_DIRS_DEPTH] [--leading-dirs-consider LEADING_DIRS_CONSIDER]  [--use-
              current-dir]   [-d]   [--key]   [-e  EXCLUDE]  [-r  RENAME]  [--existing  {fail,overwrite,archive-
              suffix,numeric-suffix}] [-o ANNEX_OPTIONS] [--copy] [--no-commit] [--allow-dirty] [--stats  STATS]
              [--drop-after] [--delete-after] [--version] archive

DESCRIPTION

       This  results  in the files within archive (which must be already 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

       archive
              archive file or a key (if --key specified). Constraints: value must be a string

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

       --annex ANNEX
              annex instance to use.

       --add-archive-leading-dir
              flag to place extracted content under a directory which would correspond to archive name with suf‐
              fix  stripped.  E.g. for archive EXAMPLE.ZIP its content will be extracted under a directory EXAM‐
              PLE/.

       --strip-leading-dirs
              flag to move all files directories up, from how they were stored in an archive, if that  one  con‐
              tained a number (possibly more than 1 down) single leading directories.

       --leading-dirs-depth LEADING_DIRS_DEPTH
              maximal depth to strip leading directories to. If not specified (None), no limit.

       --leading-dirs-consider LEADING_DIRS_CONSIDER
              regular  expression(s)  for  directories  to  consider to strip away. Constraints: value must be a
              string

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

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

       --key  flag to signal if provided archive is not actually a filename on its own but an annex key.

       -e EXCLUDE, --exclude EXCLUDE
              regular expressions for filenames which to exclude from being added to annex. Applied after  --re‐
              name  if  that  one  is specified. For exact matching, use anchoring. Constraints: value must be a
              string

       -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

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

       --copy flag to copy the content of the archive instead of moving.

       --no-commit
              flag to not commit upon completion.

       --allow-dirty
              flag that operating on a dirty repository (uncommitted or untracked content) is ok.

       --stats STATS
              ActivityStats instance for global tracking.

       --drop-after
              drop extracted files after adding to annex.

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

       --version
              show the module and its version which provides the command

AUTHORS

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

datalad add-archive-content 0.15.5                 2022-02-10                     datalad add-archive-content(1)