datalad-plugin

Synopsis

datalad-plugin [-h] [-d DATASET] [-H] [--show-plugin-info] [PLUGINSPEC [PLUGINSPEC ...]]

Description

Generic plugin interface

Using this command, arbitrary DataLad plugins can be executed. Plugins in three different locations are available

  1. official plugins that are part of the local DataLad installation

  2. system-wide plugins, location configuration:

    datalad.locations.system-plugins
    
  3. user-supplied plugins, location configuration:

    datalad.locations.user-plugins
    

Identically named plugins in latter location replace those in locations searched before.

Using plugins

A list of all available plugins can be obtained by running this command without arguments:

datalad plugin

To run a specific plugin, provide the plugin name as an argument:

datalad plugin export_archive

A plugin may come with its own documentation which can be displayed upon request:

datalad plugin export_archive -H

If a plugin supports (optional) arguments, they can be passed to the plugin as key=value pairs with the name and the respective value of an argument, e.g.:

datalad plugin export_archive filename=myfile

Any number of arguments can be given. Only arguments with names supported by the respective plugin are passed to the plugin. If unsupported arguments are given, a warning is issued.

When an argument is given multiple times, all values are passed as a list to the respective argument (order of value matches the order in the plugin call):

datalad plugin fancy_plugin input=this input=that

Like in most commands, a dedicated –dataset option is supported that can be used to identify a specific dataset to be passed to a plugin’s DATASET argument. If a plugin requires such an argument, and no dataset was given, and none was found in the current working directory, the plugin call will fail. A dataset argument can also be passed alongside all other plugin arguments without using –dataset.

Options

PLUGINSPEC

plugin name plus an optional list of KEY=VALUE pairs with arguments for the plugin call. [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 for the plugin to operate on If no dataset is given, but a plugin take a dataset as an argument, 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) [Default: None]

-H, –show-plugin-help

show help for a particular. [Default: False]

–show-plugin-info

show additional information in plugin overview (e.g. plugin file location. [Default: False]

Authors

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