Man page - datalad-clean(1)

Packages contains this manual

Package:  datalad
apt-get install datalad

Manuals in package:
• datalad-download-url(1)
• datalad-no-annex(1)
• datalad-addurls(1)
• datalad-siblings(1)
• datalad-remove(1)
• datalad-drop(1)
• datalad-export-archive(1)
• datalad-export-archive-ora(1)
• datalad-create-sibling-gogs(1)
• datalad-push(1)
• datalad-create-sibling-gitea(1)
• datalad-copy-file(1)
• datalad-sshrun(1)
• datalad-subdatasets(1)
• datalad-check-dates(1)
• datalad-create-sibling-gitlab(1)
• datalad-clone(1)
• datalad-create-test-dataset(1)
• datalad-wtf(1)
• datalad-create-sibling-github(1)
• datalad-shell-completion(1)
• datalad-uninstall(1)
• datalad-create-sibling-gin(1)
• datalad-configuration(1)
• datalad-update(1)
• datalad-get(1)
• datalad(1)
• datalad-clean(1)
• datalad-create-sibling-ria(1)
• datalad-rerun(1)
• datalad-create(1)
• datalad-unlock(1)
• datalad-status(1)
• datalad-run(1)
• datalad-foreach-dataset(1)
• datalad-install(1)
• datalad-add-archive-content(1)
• datalad-create-sibling(1)
• datalad-run-procedure(1)
• datalad-save(1)
• datalad-diff(1)
• datalad-add-readme(1)
• datalad-export-to-figshare(1)
Documentations in package:
• datalad

Manual

datalad clean

NAME
SYNOPSIS
DESCRIPTION
Examples
OPTIONS
AUTHORS

---

NAME

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

SYNOPSIS

datalad clean [-h] [-d DATASET] [--what [WHAT ...]] [--dry-run] [-r] [-R LEVELS] [--version]

DESCRIPTION

Removes temporary files and directories left behind by DataLad and git-annex in a dataset.

Examples

Clean all known temporary locations of a dataset::

% datalad clean

Report on all existing temporary locations of a dataset::

% datalad clean --dry-run

Clean all known temporary locations of a dataset and all its subdatasets::

% datalad clean -r

Clean only the archive extraction caches of a dataset and all its subdatasets::

% datalad clean --what cached-archives -r

Report on existing annex transfer files of a dataset and all its subdatasets::

% datalad clean --what annex-transfer -r --dry-run

OPTIONS

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

--what [ WHAT ...]

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

--dry-run

Report on cleanable locations - not actually cleaning up anything.

-r , --recursive

if set, recurse into potential subdatasets.

-R LEVELS, --recursion-limit LEVELS

limit recursion into subdatasets to the given number of levels. Constraints: value must be convertible to type ’int’ or value must be NONE

--version

show the module and its version which provides the command

AUTHORS

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

---