Rename module info subcommand to module view (#7052) [ci fast]

* Rename `module info` subcommand to `module inspect`

Keep `info` as a backward-compatible alias. Adds a generic
`getAliases()` hook on `CmdBase` so subcommands can declare extra
names, and wires it through `CmdModule` so both the JCommander parser
and the usage/help lookup recognize aliases.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>

* Rename subcommand to `module view` and update docs

Switch the new name from `inspect` to `view`. The `info` alias is
still kept for backward compatibility. Update the CLI reference,
module guide and 26.04 migration notes to reflect the new name.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>

* update docs

Signed-off-by: Ben Sherman <bentshermann@gmail.com>

* update class names

Signed-off-by: Ben Sherman <bentshermann@gmail.com>

---------

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Ben Sherman <bentshermann@gmail.com>

Author: 3 people

docs/cli.md

@@ -323,19 +323,19 @@ See {ref}`cli-module-list` for more information.
 
 ### Viewing module information
 
-The `module info` command displays detailed metadata and usage information for a specific module from the registry.
+The `module view` command displays detailed metadata and usage information for a specific module from the registry.
 
 Use this to understand module requirements, view input/output specifications, see available tools, or generate usage templates before installing or running a module.
 
 ```console
-$ nextflow module info nf-core/fastqc
-$ nextflow module info nf-core/fastqc -version 1.0.0
-$ nextflow module info nf-core/fastqc -output json
+$ nextflow module view nf-core/fastqc
+$ nextflow module view nf-core/fastqc -version 1.0.0
+$ nextflow module view nf-core/fastqc -output json
 ```
 
 The output includes the module's version, description, authors, keywords, tools, input/output channels, and a generated usage template showing how to run the module. Use `-json` for machine-readable output suitable for programmatic access.
 
-See {ref}`cli-module-info` for more information.
+See {ref}`cli-module-view` for more information.
 
 ### Running modules directly
 
@@ -358,7 +358,7 @@ $ nextflow module run nf-core/salmon \
     -resume
 ```
 
-Process inputs can be specified like params on the command line. For example, `--reads reads.fq` corresponds to the `reads` input in the `nf-core/salmon` module. Run `nextflow module info nf-core/salmon` to see the available params for the module.
+Process inputs can be specified like params on the command line. For example, `--reads reads.fq` corresponds to the `reads` input in the `nf-core/salmon` module. Run `nextflow module view nf-core/salmon` to see the available params for the module.
 
 See {ref}`cli-module-run` for more information.
 

docs/migrations/26-04.md

@@ -23,8 +23,8 @@ nextflow module run nf-core/fastqc --meta.id 1 --reads sample1.fastq
 # Search for modules in registry
 nextflow module search bwa
 
-# Get info about a module
-nextflow module info nf-core/bwa/mem
+# View info about a module
+nextflow module view nf-core/bwa/mem
 
 # Install a module
 nextflow module install nf-core/bwa/mem

docs/module.md

@@ -370,11 +370,11 @@ By default, both the module files and the `.module-info` file are removed. Use t
 
 ### Viewing module information
 
-Use the `module info` command to display metadata and a usage template for a module:
+Use the `module view` command to display metadata and a usage template for a module:
 
 ```console
-$ nextflow module info nf-core/fastqc
-$ nextflow module info nf-core/fastqc -version 1.0.0
+$ nextflow module view nf-core/fastqc
+$ nextflow module view nf-core/fastqc -version 1.0.0
 ```
 
 The output includes the module description, authors, keywords, tools, inputs, outputs, and a ready-to-use command-line template. Use `-o json` to get machine-readable output.

docs/reference/cli.md

@@ -1171,33 +1171,6 @@ The `module` command provides a comprehensive system for managing registry-based
   $ nextflow module create myorg/my-module
   ```
 
-(cli-module-info)=
-
-`info [options] [namespace/name]`
-
-: Display detailed information about a module from the registry.
-: Shows module name, version, description, and other metadata, as well as example usage.
-: The following options are available:
-
-  `-version`
-  : Specify the module version to query (e.g., `1.0.0`). If not specified, displays information for the latest version.
-
-  `-o, -output` (`text`)
-  : Output mode for info results. Options: `text` (default), `json`.
-
-: **Examples:**
-
-  ```console
-  # Display information for latest version
-  $ nextflow module info nf-core/fastqc
-
-  # Display information for specific version
-  $ nextflow module info nf-core/fastqc -version 1.0.0
-
-  # Get results as JSON
-  $ nextflow module info nf-core/fastqc -output json
-  ```
-
 (cli-module-install)=
 
 `install [options] [namespace/name]`
@@ -1422,6 +1395,33 @@ The `module` command provides a comprehensive system for managing registry-based
   $ nextflow module validate ./modules/myorg/my-module
   ```
 
+(cli-module-view)=
+
+`view [options] [namespace/name]`
+
+: Display detailed information about a module from the registry.
+: Shows module name, version, description, and other metadata, as well as example usage.
+: The following options are available:
+
+  `-version`
+  : Specify the module version to query (e.g., `1.0.0`). If not specified, displays information for the latest version.
+
+  `-o, -output` (`text`)
+  : Output format. Options: `text` (default), `json`.
+
+: **Examples:**
+
+  ```console
+  # Display information for latest version
+  $ nextflow module view nf-core/fastqc
+
+  # Display information for specific version
+  $ nextflow module view nf-core/fastqc -version 1.0.0
+
+  # Get results as JSON
+  $ nextflow module view nf-core/fastqc -output json
+  ```
+
 (cli-plugin)=
 
 ### `plugin`

modules/nextflow/src/main/groovy/nextflow/cli/CmdBase.groovy

@@ -30,6 +30,8 @@ abstract class CmdBase implements Runnable {
 
     abstract String getName()
 
+    List<String> getAliases() { Collections.emptyList() }
+
     protected List<String> getUnknownOptions(){ return this.unknownOptions }
 
     void setUnknownOptions(List<String> options){ this.unknownOptions = options }

modules/nextflow/src/main/groovy/nextflow/cli/CmdModule.groovy

@@ -23,7 +23,7 @@ import com.beust.jcommander.Parameters
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
 import nextflow.cli.module.CmdModuleCreate
-import nextflow.cli.module.CmdModuleInfo
+import nextflow.cli.module.CmdModuleView
 import nextflow.cli.module.CmdModuleInstall
 import nextflow.cli.module.CmdModuleList
 import nextflow.cli.module.CmdModulePublish
@@ -57,7 +57,7 @@ class CmdModule extends CmdBase implements UsageAware {
         commands << new CmdModuleList()
         commands << new CmdModuleRemove()
         commands << new CmdModuleSearch()
-        commands << new CmdModuleInfo()
+        commands << new CmdModuleView()
         commands << new CmdModulePublish()
         commands << new CmdModuleSpec()
         commands << new CmdModuleValidate()
@@ -70,7 +70,7 @@ class CmdModule extends CmdBase implements UsageAware {
             // Register all subcommands
             commands.each { cmd ->
                 cmd.launcher = this.launcher
-                this.jCommander.addCommand(cmd.getName(), cmd, new String[0])
+                this.jCommander.addCommand(cmd.getName(), cmd, cmd.getAliases() as String[])
             }
         }
         return jCommander
@@ -117,7 +117,7 @@ class CmdModule extends CmdBase implements UsageAware {
     }
 
     private CmdBase findCmd(String name) {
-        commands.find { it.name == name }
+        commands.find { it.name == name || name in it.aliases }
     }
 
     /**

…nextflow/cli/module/CmdModuleInfo.groovy …nextflow/cli/module/CmdModuleView.groovymodules/nextflow/src/main/groovy/nextflow/cli/module/CmdModuleInfo.groovy renamed to modules/nextflow/src/main/groovy/nextflow/cli/module/CmdModuleView.groovy modules/nextflow/src/main/groovy/nextflow/cli/module/CmdModuleInfo.groovy renamed to modules/nextflow/src/main/groovy/nextflow/cli/module/CmdModuleView.groovy

@@ -41,14 +41,14 @@ import java.nio.file.Path
 import java.nio.file.Paths
 
 /**
- * Module info subcommand - displays module metadata and usage template
+ * Module view subcommand - displays module info and usage template
  *
  * @author Jorge Ejarque <jorge.ejarque@seqera.io>
  */
 @Slf4j
 @CompileStatic
 @Parameters(commandDescription = "Show module information and usage template")
-class CmdModuleInfo extends CmdBase {
+class CmdModuleView extends CmdBase {
 
     @Parameter(names = ["-version"], description = "Module version")
     String version
@@ -82,7 +82,12 @@ class CmdModuleInfo extends CmdBase {
 
     @Override
     String getName() {
-        return 'info'
+        return 'view'
+    }
+
+    @Override
+    List<String> getAliases() {
+        return List.of('info')
     }
 
     @Override

…flow/cli/module/CmdModuleInfoTest.groovy …flow/cli/module/CmdModuleViewTest.groovymodules/nextflow/src/test/groovy/nextflow/cli/module/CmdModuleInfoTest.groovy renamed to modules/nextflow/src/test/groovy/nextflow/cli/module/CmdModuleViewTest.groovy modules/nextflow/src/test/groovy/nextflow/cli/module/CmdModuleInfoTest.groovy renamed to modules/nextflow/src/test/groovy/nextflow/cli/module/CmdModuleViewTest.groovy

@@ -34,11 +34,11 @@ import test.OutputCapture
 import java.nio.file.Path
 
 /**
- * Tests for CmdModuleInfo command
+ * Tests for CmdModuleView command
  *
  * @author Jorge Ejarque <jorge.ejarque@seqera.io>
  */
-class CmdModuleInfoTest extends Specification {
+class CmdModuleViewTest extends Specification {
 
     @Rule
     OutputCapture capture = new OutputCapture()
@@ -62,7 +62,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -110,7 +110,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.version = '0.9.0'
         cmd.launcher = Mock(Launcher) {
@@ -149,7 +149,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.output = 'json'
         cmd.launcher = Mock(Launcher) {
@@ -207,7 +207,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -266,7 +266,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -324,7 +324,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -386,7 +386,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -427,7 +427,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.version = '2.0.0'
         cmd.launcher = Mock(Launcher) {
@@ -477,7 +477,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -504,7 +504,7 @@ class CmdModuleInfoTest extends Specification {
 
     def 'should fail with no arguments'() {
         given:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
         }
@@ -520,7 +520,7 @@ class CmdModuleInfoTest extends Specification {
 
     def 'should fail with multiple arguments'() {
         given:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
         }
@@ -550,7 +550,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -593,7 +593,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -649,7 +649,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.launcher = Mock(Launcher) {
             getOptions() >> null
@@ -701,7 +701,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.output = 'json'
         cmd.launcher = Mock(Launcher) {
@@ -776,7 +776,7 @@ class CmdModuleInfoTest extends Specification {
         )
 
         and:
-        def cmd = new CmdModuleInfo()
+        def cmd = new CmdModuleView()
         cmd.args = ['nf-core/fastqc']
         cmd.output = 'json'
         cmd.launcher = Mock(Launcher) {