Skip to content

Commit 3be2f02

Browse files
committed
Update docs
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
1 parent 6c15bc8 commit 3be2f02

4 files changed

Lines changed: 151 additions & 152 deletions

File tree

docs/cli.md

Lines changed: 44 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -269,49 +269,42 @@ See {ref}`cli-secrets` for more information.
269269
:::{versionadded} 26.04.0
270270
:::
271271

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.
273273

274274
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.
275275

276-
### Installing modules
276+
### Searching for modules
277277

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.
279279

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.
281281

282282
```console
283-
$ nextflow module install nf-core/fastqc
284-
$ nextflow module install nf-core/fastqc -version 1.0.0
283+
$ nextflow module search alignment
284+
$ nextflow module search "quality control" -limit 10
285+
$ nextflow module search bwa -output json
285286
```
286287

287-
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.
288289

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.
292291

293-
### Running modules directly
292+
### Installing modules
294293

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.
296295

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.
298297

299298
```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
299+
$ nextflow module install nf-core/fastqc
300+
$ nextflow module install nf-core/fastqc -version 1.0.0
302301
```
303302

304-
The command accepts all standard Nextflow execution options (`-profile`, `-resume`, etc.):
303+
The installed module will be available in `modules/nf-core/fastqc`.
305304

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.
313306

314-
See {ref}`cli-module-run` for more information.
307+
See {ref}`cli-module-install` for more information.
315308

316309
### Listing modules
317310

@@ -324,26 +317,10 @@ $ nextflow module list
324317
$ nextflow module list -output json
325318
```
326319

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.
328321

329322
See {ref}`cli-module-list` for more information.
330323

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.
336-
337-
```console
338-
$ nextflow module search alignment
339-
$ nextflow module search "quality control" -limit 10
340-
$ nextflow module search bwa -output json
341-
```
342-
343-
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-
347324
### Viewing module information
348325

349326
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,
360337

361338
See {ref}`cli-module-info` for more information.
362339

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+
363365
### Removing modules
364366

365367
The `module remove` command deletes modules from your project, removing local files and configuration entries.
@@ -386,7 +388,7 @@ $ nextflow module publish myorg/my-module
386388
$ nextflow module publish myorg/my-module -dry-run
387389
```
388390

389-
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.
390392

391393
Use `-dry-run` to validate your module structure without uploading.
392394

docs/module.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ Modules are designed to be easy to share and re-use across different pipelines,
293293
:::{versionadded} 26.04.0
294294
:::
295295

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.
297297

298298
### Installing modules from a registry
299299

@@ -323,8 +323,7 @@ For ad-hoc tasks or testing, you can run a module directly without creating a wo
323323
$ nextflow module run nf-core/fastqc --input 'data/*.fastq.gz'
324324
```
325325

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.
328327

329328
### Discovering modules
330329

@@ -374,7 +373,7 @@ $ nextflow module info nf-core/fastqc
374373
$ nextflow module info nf-core/fastqc -version 1.0.0
375374
```
376375

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.
378377

379378
### Publishing modules
380379

0 commit comments

Comments
 (0)