.TH "datalad clean" "1" "2023\-07\-03" "datalad clean 0.19.2"
.SH NAME
\fBdatalad clean\fR \- clean up after DataLad (possible temporary files etc.)
.SH SYNOPSIS
.nh
.HP
\fBdatalad clean\fR [-h] [-d\~DATASET] [--what [WHAT ...]] [--dry-run] [-r] [-R\~LEVELS] [--version]


.hy
.SH DESCRIPTION

Removes temporary files and directories left behind by DataLad and
git\-annex in a dataset.
.PP
.SS Examples
.PP
Clean all known temporary locations of a dataset::
.PP
 % datalad clean
.PP
Report on all existing temporary locations of a dataset::
.PP
 % datalad clean \-\-dry\-run
.PP
Clean all known temporary locations of a dataset and all its
subdatasets::
.PP
 % datalad clean \-r
.PP
Clean only the archive extraction caches of a dataset and all its
subdatasets::
.PP
 % datalad clean \-\-what cached\-archives \-r
.PP
Report on existing annex transfer files of a dataset and all its
subdatasets::
.PP
 % datalad clean \-\-what annex\-transfer \-r \-\-dry\-run

.SH OPTIONS
.TP
\fB-h\fR, \fB--help\fR, \fB--help-np\fR
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
.TP
\fB-d\fR \fI\s-1DATASET\s0\fR, \fB--dataset\fR \fI\s-1DATASET\s0\fR
specify the dataset to perform the clean operation on. If no dataset is given, an attempt is made to identify the dataset in 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
.TP
\fB--what\fR [\fI\s-1WHAT\s0\fR ...]
What to clean. If none specified -- all known targets are considered. Constraints: value must be one of ('cached-archives', 'annex-tmp', 'annex-transfer', 'search-index') or value must be NONE
.TP
\fB--dry-run\fR
Report on cleanable locations - not actually cleaning up anything.
.TP
\fB-r\fR, \fB--recursive\fR
if set, recurse into potential subdatasets.
.TP
\fB-R\fR LEVELS, \fB--recursion-limit\fR LEVELS
limit recursion into subdatasets to the given number of levels. Constraints: value must be convertible to type 'int' or value must be NONE
.TP
\fB--version\fR
show the module and its version which provides the command
.SH AUTHORS
 datalad is developed by The DataLad Team and Contributors <team@datalad.org>.