NAME

       datalad uninstall - uninstall subdatasets

SYNOPSIS

       datalad  uninstall  [-h] [-d DATASET] [-r] [--nocheck] [--if-dirty {fail,save-before,ignore}] [--version]
              [PATH ...]

DESCRIPTION

       This command can be used to uninstall any number of installed subdatasets.  This command  will  error  if
       individual  files or non-dataset directories are given as input (use the drop or remove command depending
       on the desired goal), nor will it uninstall top-level datasets (i.e. datasets that are not  a  subdataset
       in another dataset; use the remove command for this purpose).

       By default, the availability of at least one remote copy for each currently available file in any dataset
       is verified. As these checks could lead to slow operation (network latencies, etc), they can be disabled.

       Any number of paths to process can be given as input. Recursion into subdatasets needs to  be  explicitly
       enabled,  while  recursion  into  subdirectories  within  a  dataset  is  done automatically. An optional
       recursion limit is applied relative to each given input path.

   Examples
       Uninstall a subdataset (undo installation)::

        % datalad uninstall <path/to/subds>

       Uninstall a subdataset and all potential subdatasets::

        % datalad uninstall -r <path/to/subds>

       Skip checks that ensure a minimal number of (remote) sources::

        % datalad uninstall <path/to/subds> --nocheck

OPTIONS

       PATH   path/name of the component to be uninstalled. 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

       -d DATASET, --dataset DATASET
              specify  the  dataset  to  perform the operation on. If no dataset is given, an attempt is made to
              identify a dataset based on the PATH given. Constraints: Value  must  be  a  Dataset  or  a  valid
              identifier of a Dataset (e.g. a path)

       -r, --recursive
              if set, recurse into potential subdataset.

       --nocheck
              whether  to  perform checks to assure the configured minimum number (remote) source for data. Give
              this option to skip checks.

       --if-dirty {fail, save-before, ignore}
              desired behavior if a dataset with unsaved changes is discovered: 'fail' will trigger an error and
              further  processing  is  aborted;  'save-before'  will  save all changes prior any further action;
              'ignore' let's datalad proceed as if the dataset would not have unsaved changes. [Default:  'save-
              before']

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

AUTHORS

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