bionic (1) datalad-run.1.gz

Provided by: datalad_0.9.3-1_all bug

SYNOPSIS

       datalad-run [-h] [-d DATASET] [-m MESSAGE] [--rerun] ...

DESCRIPTION

       Run an arbitrary command and record its impact on a dataset.

       It is recommended to craft the command such that it can run in the root directory of the dataset that the
       command will be recorded in. However, as long as the command is executed somewhere underneath the dataset
       root, the exact location will be recorded relative to the dataset root.

       If the executed command did not alter the dataset in any way, no record of the command execution is made.

       If  the  given  command  errors,  a COMMANDERROR exception with the same exit code will be raised, and no
       modifications will be saved.

OPTIONS

       SHELL COMMAND
              command for execution. [Default: None]

       -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 record the command results in. An attempt is made to identify the dataset
              based on the current working directory. If a dataset is given, the command will be executed in the
              root  directory  of  this dataset. Constraints: Value must be a Dataset or a valid identifier of a
              Dataset (e.g. a path) [Default: None]

       -m MESSAGE, --message MESSAGE
              a description of the state or the changes made to a dataset. Constraints: value must be  a  string
              [Default: None]

       --rerun
              re-run  the  command  recorded  in the last saved change (if any). Note: This option is deprecated
              since version 0.9.2 and will be removed in a later release. Use `datalad rerun` instead. [Default:
              False]

AUTHORS

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