datalad containers-remove

Synopsis

datalad containers-remove [-h] [-d DATASET] [-i] [--version] NAME

Description

Remove a known container from a dataset

This command is only removing a container from the committed Dataset configuration (configuration scope branch). It will not modify any other configuration scopes.

This command is not dropping the container image associated with the removed record, because it may still be needed for other dataset versions. In order to drop the container image, use the 'drop' command prior to removing the container configuration.

Options

NAME

name of the container to remove. 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 from removing a container. If no dataset is given, an attempt is made to identify the dataset based on the 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

-i, -\-remove-image

if set, remove container image as well. Even with this flag, the container image content will not be dropped. Use the 'drop' command explicitly before removing the container configuration.

-\-version

show the module and its version which provides the command

Authors

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