Skip to main content

nextflow config

Print the resolved pipeline configuration.

Usage​

$ nextflow config [options] [project name or path]

Description​

The config command prints the project's resolved configuration, that is, the settings from nextflow.config and any profiles and parameters Nextflow applies when it runs the pipeline. See Config profiles for more information.

Options​

-flat​
Deprecated in version 24.10

Use -o flat instead.

Print config using flat notation.

-h, -help​

Print the command usage.

-o, -output​
Added in version 24.10

Print the config using the specified format: canonical (default), flat, json, properties or yaml.

-profile​

Choose a configuration profile.

-properties​
Deprecated in version 24.10

Use -o properties instead.

Print config using Java properties notation.

-r, -revision​
Added in version 26.04

Project revision. Can be a git branch, tag, or commit SHA number.

-a, -show-profiles​

Show all configuration profiles.

-sort​

Sort config attributes.

-value​
Added in version 23.10

Print the value of a config option, or fail if the option is not defined.

Examples​

Print the resolved config using the default group key-value notation:

$ nextflow config

docker {
    enabled = true
}

process {
    executor = 'local'
}

Print the config using flat notation:

$ nextflow config -o flat

docker.enabled = true
process.executor = 'local'

Print the config using Java properties notation:

$ nextflow config -o properties

docker.enabled = true
process.executor = local

Print the value of a specific configuration property:

$ nextflow config -value process.executor
local

Print all profiles from the project's configuration:

$ nextflow config -show-profiles

docker {
    enabled = true
}

profiles {
    standard {
        process {
            executor = 'local'
        }
    }
    cloud {
        process {
            executor = 'cirrus'
            container = 'cbcrg/imagex'
        }
    }
}
On this Page