Nextflow module registry
New in version 26.04.0.
The Nextflow module registry is a central repository for sharing Nextflow modules. It provides module discovery, version tracking, and integrity verification.
The module registry shares its login, access tokens, and web interface with the Nextflow plugin registry.
Claiming a namespace
A namespace is an organizational prefix that groups related modules together (e.g., the namespace nf-core owns modules like nf-core/fastqc and nf-core/samtools).
As a namespace member, you can publish new modules and release new versions under that prefix.
Each namespace can have multiple members who share publishing rights.
To claim a namespace:
Open the Nextflow module registry in a browser.
Log in to Seqera with your GitHub or Google account, or by providing an email address.
Note
If you are logging in for the first time, Seqera sends an authentication link to your email address to complete the login process.
Go to My Resources and select the My Namespaces tab.
Enter your namespace name in the Claim Namespace field.
Select Claim Namespace.
The namespace shows as PENDING REVIEW until an administrator approves the request.
Admin approval is required only once.
Once approved, you can publish modules using the nextflow module publish command.
Creating an access token
An API access token is required to publish modules to the registry.
To create an API access token:
Open the Nextflow module registry in a browser.
Log in to Seqera with your GitHub or Google account, or by providing an email address.
Note
If you are logging in for the first time, Seqera sends an authentication link to your email address to complete the login process.
Go to My Resources and select the My access tokens tab.
Under Create New Access Token, enter a descriptive name for the Token name and select the token duration from the Expiry drop down.
Select Generate Token.
Copy the token and store it somewhere safe. You cannot view it again after this step.
Once you have your token, see Publishing modules for instructions on how to use it.
Viewing modules
View the modules you have published in the registry:
Open the Nextflow module registry in a browser.
Log in and go to My Resources.
Select the My Modules tab.
The page lists all modules published under your namespaces, along with their versions and status.
Publishing modules
Publishing requires a claimed namespace and an access token.
Provide your registry token in one of two ways:
Environment variable:
$ export NXF_REGISTRY_TOKEN=<token>
$ nextflow module publish myorg/my-module
Nextflow configuration:
registry {
apiKey = '<token>'
}
Use the module publish command to upload a module to the registry:
$ nextflow module publish myorg/my-module
Provide a namespace/name reference (for an already-installed module) or a local directory path containing the module files.
The module directory must include the following files:
main.nf: The module script.meta.yml: The module spec with name, version, description, and license.README.md: Module documentation.
Use -dry-run to validate the module structure without uploading:
$ nextflow module publish myorg/my-module -dry-run
Use the module spec and module validate commands to prepare and verify a module before publishing. See Developing modules for a guide on creating modules.
See publish [options] [namespace/name | path] for the full command reference.
Registry configuration
By default, Nextflow uses the public registry at https://registry.nextflow.io.
Configure alternative or additional registries in your Nextflow configuration:
registry {
url = [
'https://private.registry.myorg.com',
'https://registry.nextflow.io'
]
apiKey = '${MYORG_TOKEN}'
}
Nextflow queries registries in the order you specify until it finds a module.
The apiKey is used only for the primary (first) registry.
Specify a registry when publishing:
$ nextflow module publish myorg/my-module -registry 'https://private.registry.myorg.com'