LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

nf-core

CLI for the nf-core community collection of Nextflow pipelines

TLDR

List all available nf-core pipelines
$ nf-core pipelines list
copy
Download a pipeline for offline use
$ nf-core pipelines download [pipeline-name]
copy
Launch a pipeline interactively
$ nf-core pipelines launch [pipeline-name]
copy
Show information about a pipeline
$ nf-core pipelines info [pipeline-name]
copy
Create a new pipeline from template
$ nf-core pipelines create
copy
Lint a pipeline for best practices
$ nf-core pipelines lint
copy
List available pipeline schemas
$ nf-core pipelines schema lint
copy

SYNOPSIS

nf-core [options] command [subcommand] [args]

DESCRIPTION

nf-core is the command-line interface for the nf-core community, which curates a collection of high-quality bioinformatics pipelines built with Nextflow. The tool helps users find, download, launch, and develop pipelines following community best practices.
The download command fetches pipelines along with their Singularity or Docker container images for use in offline or air-gapped environments. The launch command provides an interactive interface for setting pipeline parameters, generating a params file, and starting a run.
For pipeline developers, create scaffolds a new pipeline from the nf-core template with CI, documentation, and testing built in. The lint command validates that a pipeline follows nf-core guidelines for code quality, documentation, and reproducibility.

PARAMETERS

--help

Display help information.
--version
Show version.
--verbose
Increase output verbosity.
--hide-progress
Do not show progress bars.
--log-file FILE
Save log output to a file.

COMMANDS

pipelines list

List available nf-core pipelines with stars, releases, and descriptions.
pipelines download
Download a pipeline and its container images for offline use.
pipelines launch
Interactively configure and launch a pipeline run.
pipelines create
Create a new pipeline from the nf-core template.
pipelines lint
Check pipeline code against nf-core best practices.
pipelines info
Show detailed information about a pipeline.
pipelines schema
Manage pipeline parameter schema files.

CAVEATS

Requires Python 3.8 or later. Nextflow must be installed separately to actually run pipelines. Pipeline downloads can be large when including container images. Internet access is required for listing and downloading pipelines.

HISTORY

nf-core was established in 2018 as a community effort to create a curated set of Nextflow pipelines following best practices for reproducibility and portability. The project was published in Nature Biotechnology in 2020. It has grown to include over 100 pipelines covering genomics, proteomics, imaging, and other bioinformatics domains.

SEE ALSO

nextflow(1), conda(1), docker(1)

Copied to clipboard
Kai