Skip to main content

nextflow plugin

Manage plugins and run plugin-specific commands.

Usage​

$ nextflow plugin <subcommand> [options]

Description​

The plugin command creates plugin scaffolds, installs plugins, and runs plugin-specific commands. See Plugins for more information.

Options​

-h, -help​

Print the command usage.

Subcommands​

create​
Added in version 25.04

Create a plugin scaffold using the Nextflow plugin template. See Creating a plugin for more information.

install <plugin[@version],..>​

Install a plugin. Specify multiple plugins as a comma-separated list. Each plugin id is a name and an optional version, separated by a @.

<plugin>:<subcommand> [options]​

Execute a plugin-specific command. See the documentation of the individual plugin for the commands it provides.

Examples​

Create a plugin scaffold:

$ nextflow plugin create

Install a plugin:

$ nextflow plugin install my-plugin

Install a specific plugin version:

$ nextflow plugin install my-plugin@0.5.0

Install multiple plugins:

$ nextflow plugin install my-plugin@0.5.0,other-plugin

Execute a plugin-specific command:

$ nextflow plugin my-plugin:hello --alpha --beta
On this Page