Skip to content

Installation

This guide covers installing the nf-slack plugin in your Nextflow pipeline.

Prerequisites

Adding the Plugin

Add the nf-slack plugin to your nextflow.config:

plugins {
    id 'nf-slack@0.3.1'
}

Using Multiple Plugins?

If you already have a plugins block, just add the nf-slack entry:

plugins {
    id 'nf-validation'
    id 'nf-slack@0.3.1'  // Add this line
}

Specifying a Version

You can specify a particular version of the plugin:

plugins {
    id 'nf-slack@0.3.1'  // Use a specific version
}

To use the latest version, omit the version number:

plugins {
    id 'nf-slack'  // Uses the latest version
}

Manual Installation

Nextflow will automatically download and install the plugin when you run your pipeline. However, if you want to manually install it, you can do so using the Nextflow CLI:

nextflow plugin install nf-slack

You should see nf-slack in the list of installed plugins.

Local Installation (Development)

If you want to install a local development version of the plugin:

  1. Clone the repository
git clone https://github.com/seqeralabs/nf-slack.git
cd nf-slack
  1. Install locally
make install

This will build and install the plugin to your local Nextflow plugins directory. For more details on development setup, see the Contributing guide.

Next Steps