You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli.md
+44-42Lines changed: 44 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -269,49 +269,42 @@ See {ref}`cli-secrets` for more information.
269
269
:::{versionadded} 26.04.0
270
270
:::
271
271
272
-
Module management commands enable working with reusable, registry-based modules. The Nextflow module system allows you to install, run, search, and publish standardized modules from registries, eliminating duplicate work and spreading improvements throughout the community.
272
+
The `module` command enables working with reusable, registry-based modules. The Nextflow module system allows you to install, run, search, and publish standardized modules from registries, eliminating duplicate work and sharing improvements with the community.
273
273
274
274
Use these commands to discover modules in registries, install them into your project, run them directly without creating a workflow, and publish your own modules for others to use.
275
275
276
-
### Installing modules
276
+
### Searching for modules
277
277
278
-
The `module install` command downloads modules from a registry and makes them available in your workflow. Modules are stored locally in the `modules/` directory. An additional `.module-info` file is created during to store installation information such as the module checksum at installation and the registry URL.
278
+
The `module search` command queries the module registry to discover available modules by keyword or name.
279
279
280
-
Use this to add reusable modules to your pipeline, manage module versions, or update modules to newer versions.
280
+
Use this to find modules for specific tasks, explore available tools, or discover community modules.
After installation, module will be available in `modules/nf-core/fastqc`.
288
+
Results include module names, versions, descriptions, and download statistics. Use `-limit` to control the number of results and `-output json` for JSON-formatted output.
288
289
289
-
Use the `-force` flag to reinstall a module even if local modifications exist.
290
-
291
-
See {ref}`cli-module-install` for more information.
290
+
See {ref}`cli-module-search` for more information.
292
291
293
-
### Running modules directly
292
+
### Installing modules
294
293
295
-
The `module run` command executes a module directly from the registry without requiring a wrapper workflow. This provides immediate access to module functionality for ad-hoc tasks or testing.
294
+
The `module install` command downloads modules from a registry and makes them available in your workflow. Modules are stored locally in the `modules/` directory. An additional `.module-info` file is created during to store installation information such as the module checksum at installation and the registry URL.
296
295
297
-
Use this to quickly run a module, test module functionality, or execute one-off data processing tasks.
296
+
Use this to add reusable modules to your pipeline, manage module versions, or update modules to newer versions.
298
297
299
298
```console
300
-
$ nextflow module run nf-core/fastqc --input 'data/*.fastq.gz'
301
-
$ nextflow module run nf-core/fastqc --input 'data/*.fastq.gz' -version 1.0.0
The command accepts all standard Nextflow execution options (`-profile`, `-resume`, etc.):
303
+
The installed module will be available in `modules/nf-core/fastqc`.
305
304
306
-
```console
307
-
$ nextflow module run nf-core/salmon \
308
-
--reads reads.fq \
309
-
--index salmon_index \
310
-
-profile docker \
311
-
-resume
312
-
```
305
+
Use the `-force` flag to reinstall a module even if local modifications exist.
313
306
314
-
See {ref}`cli-module-run` for more information.
307
+
See {ref}`cli-module-install` for more information.
315
308
316
309
### Listing modules
317
310
@@ -324,26 +317,10 @@ $ nextflow module list
324
317
$ nextflow module list -output json
325
318
```
326
319
327
-
The output shows each module's name, installed version, and whether it has been modified locally. Use `-json` for machine-readable output suitable for scripting.
320
+
The output shows each module's name, installed version, and whether it has been modified locally. Use `-o json` for JSON-formatted output.
328
321
329
322
See {ref}`cli-module-list` for more information.
330
323
331
-
### Searching for modules
332
-
333
-
The `module search` command queries the module registry to discover available modules by keyword or name.
334
-
335
-
Use this to find modules for specific tasks, explore available tools, or discover community contributions.
Results include module names, versions, descriptions, and download statistics. Use `-limit` to control the number of results and `-output json` for programmatic access.
344
-
345
-
See {ref}`cli-module-search` for more information.
346
-
347
324
### Viewing module information
348
325
349
326
The `module info` command displays detailed metadata and usage information for a specific module from the registry.
@@ -360,6 +337,31 @@ The output includes the module's version, description, authors, keywords, tools,
360
337
361
338
See {ref}`cli-module-info` for more information.
362
339
340
+
### Running modules directly
341
+
342
+
The `module run` command executes a module directly from the registry without requiring a wrapper workflow. This provides immediate access to module functionality for ad-hoc tasks or testing.
343
+
344
+
Use this to quickly run a module, test module functionality, or execute one-off data processing tasks.
345
+
346
+
```console
347
+
$ nextflow module run nf-core/fastqc --input 'data/*.fastq.gz'
348
+
$ nextflow module run nf-core/fastqc --input 'data/*.fastq.gz' -version 1.0.0
349
+
```
350
+
351
+
The command accepts all standard Nextflow execution options (`-profile`, `-resume`, etc.):
352
+
353
+
```console
354
+
$ nextflow module run nf-core/salmon \
355
+
--reads reads.fq \
356
+
--index salmon_index \
357
+
-profile docker \
358
+
-resume
359
+
```
360
+
361
+
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.
362
+
363
+
See {ref}`cli-module-run` for more information.
364
+
363
365
### Removing modules
364
366
365
367
The `module remove` command deletes modules from your project, removing local files and configuration entries.
Publishing requires authentication via the `NXF_REGISTRY_TOKEN` environment variable or `registry.apiKey`in the Nextflow configuration. The module must include `main.nf`, `meta.yml`, and `README.md` files.
391
+
Publishing requires authentication via the `NXF_REGISTRY_TOKEN` environment variable or the `registry.apiKey`config option. The module must include `main.nf`, `meta.yml`, and `README.md` files.
390
392
391
393
Use `-dry-run` to validate your module structure without uploading.
Copy file name to clipboardExpand all lines: docs/module.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -293,7 +293,7 @@ Modules are designed to be easy to share and re-use across different pipelines,
293
293
:::{versionadded} 26.04.0
294
294
:::
295
295
296
-
Nextflow provides a module registry that enables you to install, share, and manage modules from centralized registries. This system provides version management, integrity checking, and seamless integration with the Nextflow DSL.
296
+
Nextflow provides a module registry that enables you to install, publish, and manage modules from centralized registries. This system provides version management, integrity checking, and seamless integration with the Nextflow language.
297
297
298
298
### Installing modules from a registry
299
299
@@ -323,8 +323,7 @@ For ad-hoc tasks or testing, you can run a module directly without creating a wo
323
323
$ nextflow module run nf-core/fastqc --input 'data/*.fastq.gz'
324
324
```
325
325
326
-
This command accepts all standard Nextflow options (`-profile`, `-resume`, etc.) and automatically downloads the module if not already installed.
327
-
326
+
This command accepts all standard `nextflow run` options (`-profile`, `-resume`, etc.) and automatically downloads the module if not already installed.
328
327
329
328
### Discovering modules
330
329
@@ -374,7 +373,7 @@ $ nextflow module info nf-core/fastqc
374
373
$ nextflow module info nf-core/fastqc -version 1.0.0
375
374
```
376
375
377
-
The output includes the module description, authors, keywords, tools, inputs, outputs, and a ready-to-use command-line template. Use `-json` to get machine-readable output.
376
+
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.
0 commit comments