• params
  • args
  • groovy.cli.commons.CliBuilder
• groovy script with params in Jenkins CLI

params

args

#!/usr/bin/env groovy

println ".. args : ${args} : ${args.getClass()}"

• results:

  $ groovy params.groovy
  .. args : [] : class [Ljava.lang.String;
  
  $ groovy params.groovy a b c
  .. args : [a, b, c] : class [Ljava.lang.String;
  

groovy.cli.commons.CliBuilder

[!NOTE|label:references:]

• * Groovy 2.5 CliBuilder Renewal
• Groovy Goodness: Parsing Commandline Arguments with CliBuilder
• Groovy: parsing command-line arguments with CliBuilder
• Building CLIs with Groovy's CLI Builder
• Class groovy.cli.commons.CliBuilder
• CliBuilder.groovy

#!/usr/bin/env groovy

import groovy.cli.commons.CliBuilder
import groovy.cli.commons.OptionAccessor

List<String> allList   = [ 'a', 'b', 'c', 'd', 'e', 'f' ]
List<String> list      = [ 'a', 'b', 'c' ]
Boolean shouldSuppress = true

CliBuilder cli = new CliBuilder( usage: 'params.groovy [-a|-h]' )
cli.with {
  h longOpt: 'help',        'Show usage information'
  a longOpt: 'all-plugins', 'print all plugins'
}
OptionAccessor options = cli.parse(args)

// Show usage text when -h or --help option is used.
if ( options.h ) {
  cli.usage()
  return
}
if ( options.a ) { shouldSuppress = false }

println allList.findAll{ shouldSuppress ? list.contains(it) : it }

• results:

  • --help | -h

    $ groovy params.groovy -h
    usage: params.groovy [-a|-h]
     -a,--all-plugins   print all plugins
     -h,--help          Show usage information
    
    $ groovy params.groovy --help
    usage: params.groovy [-a|-h]
     -a,--all-plugins   print all plugins
     -h,--help          Show usage information
    

  • without parameters

    $ groovy params.groovy
    [a, b, c]
    

  • --all-plugins | -a

    $ groovy params.groovy -a
    [a, b, c, d, e, f]
    
    $ groovy params.groovy --all-plugins
    [a, b, c, d, e, f]
    

groovy script with params in Jenkins CLI

[!TIPS] only allows args. CliBuilder is not supported by default.

# without parameters
$ ssh JENKINS_URL groovy =< params-args.groovy

# with parameters
#                   params add before `<`
#                          +---+
$ ssh JENKINS_URL groovy = a b c < params-args.groovy