Improve plugin docs (#3957)

Signed-off-by: Ben Sherman <[email protected]> Signed-off-by: Phil Ewels <[email protected]> Signed-off-by: Paolo Di Tommaso <[email protected]> Co-authored-by: Phil Ewels <[email protected]> Co-authored-by: Paolo Di Tommaso <[email protected]>
nextflow-io · Jul 25, 2023 · 22638d4 · 22638d4
1 parent 9a33e93
commit 22638d4
Show file tree

Hide file tree

Showing 4 changed files with 342 additions and 47 deletions.
diff --git a/docs/cli.md b/docs/cli.md
@@ -469,6 +469,8 @@ profiles {
 }
 ```
 
+(cli-console)=
+
 ### console
 
 Launch the Nextflow interactive console.
@@ -886,6 +888,26 @@ $ nextflow log tiny_leavitt -F 'process =~ /splitLetters/'
 work/1f/f1ea9158fb23b53d5083953121d6b6
 ```
 
+(cli-plugin)=
+
+### plugin
+
+Manage plugins and run plugin-specific commands.
+
+```console
+$ nextflow plugin <subcommand> [options]
+```
+
+The `plugin` command provides several subcommands for managing and using plugins:
+
+`install <plugin[@version],..>`
+
+: Install a plugin. Multiple plugins can be specified as a comma-separated list. Each plugin id consists of a name and optional version separated by a `@`.
+
+`<plugin>:<subcommand> [options]`
+
+: Execute a plugin-specific command.
+
 ### pull
 
 Download or update a project.

diff --git a/docs/config.md b/docs/config.md
@@ -1594,6 +1594,11 @@ The following environment variables control the configuration of the Nextflow ru
 `NXF_PID_FILE`
 : Name of the file where the process PID is saved when Nextflow is launched in background.
 
+`NXF_PLUGINS_TEST_REPOSITORY`
+: :::{versionadded} 23.04.0
+  :::
+: Defines a custom plugin registry or plugin release URL for testing plugins outside of the main registry. See {ref}`testing-plugins` for more information.
+
 `NXF_SCM_FILE`
 : :::{versionadded} 20.10.0
   :::