tutor plugins

Manage Tutor plugins to add new features and customise your Open edX platform.

Plugins can be downloaded from local and remote indexes. See the tutor plugins index subcommand.

After the plugin index cache has been updated, plugins can be searched with:

tutor plugins search <pattern>

Plugins are installed with:

tutor plugins install <name>

tutor plugins [OPTIONS] COMMAND [ARGS]...

disable

Disable one or more plugins. Specify ‘all’ to disable all enabled plugins at once.

tutor plugins disable [OPTIONS] plugin

Arguments

plugin: Optional argument(s)

enable

Enable a plugin

tutor plugins enable [OPTIONS] plugin

Arguments

plugin: Optional argument(s)

index

Manage plugin indices.

A plugin index is a list of Tutor plugins. An index can be public and shared with the community, or private, for instance to share plugins with a select group of users. Plugin indexes are a great way to share your plugins with other Tutor users. By default, only the official plugin index is enabled.

Plugin indexes are fetched by running:

tutor plugins update

Plugin index cache is stored locally in the following subdirectory of the Tutor project environment:

plugins/index/cache.yml

tutor plugins index [OPTIONS] COMMAND [ARGS]...

add

Add a plugin index.

The index URL will be appended with ‘{version}/plugins.yml’. The index path can be either an http(s) url or a local file path.

For official indexes, there is no need to pass a full URL. Instead, use “main” or “contrib”.

tutor plugins index add [OPTIONS] URL

Arguments

URL: Required argument

list

List plugin indexes

tutor plugins index list [OPTIONS]

remove

Remove a plugin index.

tutor plugins index remove [OPTIONS] URL

Arguments

URL: Required argument

install

Install one or more plugins.

Each plugin name can be one of:

A plugin name from the plugin indexes (see tutor plugins search)
A local file that will be copied to the plugins root
An http(s) location that will be downloaded to the plugins root

In cases 2. and 3., the plugin root corresponds to the path given by tutor plugins printroot.

tutor plugins install [OPTIONS] name

Arguments

name: Optional argument(s)

list

List installed plugins.

tutor plugins list [OPTIONS]

Options

-e, --enabled: Display enabled plugins only

printroot

Print the location of yaml-based plugins: both python v1 and yaml v0 plugins. This location can be manually defined by setting the TUTOR_PLUGINS_ROOT environment variable

tutor plugins printroot [OPTIONS]

search

Search in plugin descriptions.

tutor plugins search [OPTIONS] [PATTERN]

Arguments

PATTERN: Optional argument

show

Show plugin details from index.

tutor plugins show [OPTIONS] NAME

Arguments

NAME: Required argument

update

Update the list of available plugins.

tutor plugins update [OPTIONS]

upgrade

Upgrade one or more plugins.

Specify “all” to upgrade all installed plugins. This command will only print a warning for plugins which cannot be found.

tutor plugins upgrade [OPTIONS] name

Arguments

name: Optional argument(s)