1datalad clean(1)            General Commands Manual           datalad clean(1)
2
3
4

NAME

6       datalad clean - clean up after DataLad (possible temporary files etc.)
7

SYNOPSIS

9       datalad  clean  [-h]  [-d DATASET] [--what [WHAT ...]] [--dry-run] [-r]
10              [-R LEVELS] [--version]
11
12
13

DESCRIPTION

15       Removes temporary files and directories  left  behind  by  DataLad  and
16       git-annex in a dataset.
17
18   Examples
19       Clean all known temporary locations of a dataset::
20
21        % datalad clean
22
23       Report on all existing temporary locations of a dataset::
24
25        % datalad clean --dry-run
26
27       Clean  all  known  temporary  locations  of  a dataset and all its sub‐
28       datasets::
29
30        % datalad clean -r
31
32       Clean only the archive extraction caches of a dataset and all its  sub‐
33       datasets::
34
35        % datalad clean --what cached-archives -r
36
37       Report  on  existing annex transfer files of a dataset and all its sub‐
38       datasets::
39
40        % datalad clean --what annex-transfer -r --dry-run
41
42

OPTIONS

44       -h, --help, --help-np
45              show this help message. --help-np forcefully disables the use of
46              a pager for displaying the help message
47
48       -d DATASET, --dataset DATASET
49              specify  the  dataset  to  perform the clean operation on. If no
50              dataset is given, an attempt is made to identify the dataset  in
51              current  working directory. Constraints: Value must be a Dataset
52              or a valid identifier of a Dataset (e.g. a path) or  value  must
53              be NONE
54
55       --what [WHAT ...]
56              What  to  clean. If none specified -- all known targets are con‐
57              sidered. Constraints: value must be one  of  ('cached-archives',
58              'annex-tmp',  'annex-transfer', 'search-index') or value must be
59              NONE
60
61       --dry-run
62              Report on cleanable locations - not actually  cleaning  up  any‐
63              thing.
64
65       -r, --recursive
66              if set, recurse into potential subdatasets.
67
68       -R LEVELS, --recursion-limit LEVELS
69              limit  recursion into subdatasets to the given number of levels.
70              Constraints: value must be convertible to type  'int'  or  value
71              must be NONE
72
73       --version
74              show the module and its version which provides the command
75

AUTHORS

77        datalad is developed by The DataLad Team and Contributors <team@datal‐
78       ad.org>.
79
80
81
82datalad clean 0.19.3              2023-08-11                  datalad clean(1)
Impressum