CliOptions (nextflow 0.25.0 API)

nextflow.cli.CliOptions

Main application command line options
Authors:
Paolo Di Tommaso

Properties Summary

Properties
Type	Name and description
`boolean`	`background`
`java.util.List<java.lang.String>`	`config`
`java.util.List<java.lang.String>`	`debug` The packages to debug
`boolean`	`help` Print out the 'help' and exit
`java.util.Map<java.lang.String, java.lang.String>`	`jvmOpts`
`java.lang.String`	`logFile`
`boolean`	`quiet`
`boolean`	`selfUpdate`
`java.util.List<java.lang.String>`	`trace` the packages to trace
`java.util.List<java.lang.String>`	`userConfig`
`boolean`	`version` Print out the version number and exit

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - @com.beust.jcommander.Parameter(names = ['-bg'], description = 'Execute nextflow in background', arity = 0) boolean background
  - @com.beust.jcommander.Parameter(names=['-C'], description = 'Use the specified configuration file(s) overriding any defaults') java.util.List<java.lang.String> config
  - @com.beust.jcommander.Parameter(hidden = true, names='-debug') java.util.List<java.lang.String> debug
    
    The packages to debug
  - @com.beust.jcommander.Parameter(names = ['-h'], description = 'Print this help', help = true) boolean help
    
    Print out the 'help' and exit
  - @com.beust.jcommander.DynamicParameter(names = ['-D'], description = 'Set JVM properties' ) java.util.Map<java.lang.String, java.lang.String> jvmOpts
  - @com.beust.jcommander.Parameter(names=['-log'], description = 'Set nextflow log file path') java.lang.String logFile
  - @com.beust.jcommander.Parameter(names = ['-q','-quiet'], description = 'Do not print information messages' ) boolean quiet
  - @com.beust.jcommander.Parameter(names = ['-self-update'], description = 'Update nextflow to the latest version', arity = 0, hidden = true) boolean selfUpdate
  - @com.beust.jcommander.Parameter(names='-trace', hidden = true) java.util.List<java.lang.String> trace
    
    the packages to trace
  - @com.beust.jcommander.Parameter(names=['-c','-config'], description = 'Add the specified file to configuration set') java.util.List<java.lang.String> userConfig
  - @com.beust.jcommander.Parameter(names = ['-v','-version'], description = 'Print the program version') boolean version
    
    Print out the version number and exit

Summary:
Property

| Detail:
Property

Groovy Documentation

[Groovy] Class CliOptions

Properties Summary

Inherited Methods Summary

Property Detail

@com.beust.jcommander.Parameter(names = ['-bg'], description = 'Execute nextflow in background', arity = 0) boolean background

@com.beust.jcommander.Parameter(names=['-C'], description = 'Use the specified configuration file(s) overriding any defaults') java.util.List<java.lang.String> config

@com.beust.jcommander.Parameter(hidden = true, names='-debug') java.util.List<java.lang.String> debug

@com.beust.jcommander.Parameter(names = ['-h'], description = 'Print this help', help = true) boolean help

@com.beust.jcommander.DynamicParameter(names = ['-D'], description = 'Set JVM properties' ) java.util.Map<java.lang.String, java.lang.String> jvmOpts

@com.beust.jcommander.Parameter(names=['-log'], description = 'Set nextflow log file path') java.lang.String logFile

@com.beust.jcommander.Parameter(names = ['-q','-quiet'], description = 'Do not print information messages' ) boolean quiet

@com.beust.jcommander.Parameter(names = ['-self-update'], description = 'Update nextflow to the latest version', arity = 0, hidden = true) boolean selfUpdate

@com.beust.jcommander.Parameter(names='-trace', hidden = true) java.util.List<java.lang.String> trace

@com.beust.jcommander.Parameter(names=['-c','-config'], description = 'Add the specified file to configuration set') java.util.List<java.lang.String> userConfig

@com.beust.jcommander.Parameter(names = ['-v','-version'], description = 'Print the program version') boolean version