How to capture arguments passed to a Groovy script?

Question

I am just starting out with Groovy. I couldn't find any examples anywhere of how to handle arguments to a Groovy script and so I hacked this method myself. There must be a better way of doing this? If so, I am looking for this better way, since I am probably overlooking the obvious.

import groovy.lang.Binding;
Binding binding = new Binding();
int x = 1
for (a in this.args) {
  println("arg$x: " + a)
  binding.setProperty("arg$x", a);
  x=x+1
}
println binding.getProperty("arg1")
println binding.getProperty("arg2")
println binding.getProperty("arg3")

Solution 1

If you want more advanced parsing than just getting the arguments you can use the Groovy CliBuilder to help you. It helps you with commandline flags, optional arguments and printing the usage instruction.

Checkout CliBuilder's Javadoc or MrHakis post about it.

Solution 2

Sorry about asking the question. I just figured it out:

println args[0]
println args[1]
println args[2]

Solution 3

The simplest is just to use this.args as an array e.g.:

test.groovy

println this.args[0]

Call:

C:>groovy test this

Output:

this

Solution 4

try this:

args.each{println it}

Solution 5

It is very much similar to Java and you can use the same java syntax. For eg.

class TestExecutor {

    public static void main(def args) {
        println("Printing arguments");
        for(String arguments : args) {
            println (arguments);
        }
    }

} 

Run it and you should see the arguments printed

C:\Users\athakur\Desktop>groovy TestExecutor.groovy test1 test2 test3
Aug 16, 2014 11:47:56 AM org.codehaus.groovy.runtime.m12n.MetaInfExtensionModule
 newModule
WARNING: Module [groovy-nio] - Unable to load extension class [org.codehaus.groo
vy.runtime.NioGroovyMethods]
Printing arguments
test1
test2
test3

Also note if you do not provide main method or provide one like in above example then you can get arguments as args[i] but you can change the name of the array (again same as java). So you can have something like -

public static void main(def argsNew) {
    println("Printing arguments");
    for(String arguments : argsNew) {
        //using args in above for loop will throw error
        println (arguments);
    }
}

Point being it's not something that is hard-coded. Finally as suggested in other answer you can always use CliBuilder for smart parsing. But again in that too it internally used def options = cli.parse(args).

View more solutions

Comments

[Asgher]

Works perfectly. I didn't know about that. Here is good page where are listed all groovy script related capabilities (inlcluding args variable) - groovy.codehaus.org/Groovy+CLI

[Blessed Geek]

"//using args in above for loop will throw error" - what args ?

[Blessed Geek]

"if you do not provide main method or provide one like in above example then... but you can change the name of the array" - don't understand.

[Aniket Thakur]

@BlessedGeek that means if you do not provide main method or provide one with array name in arguments as args you can access the arguments passed with args[i]. But if you change the array name in arguments from main(def args) to main(def argsNew) which is allowed you can no longer access arguments passed as args[i] you will have to use argsNew[i] as mentioned in code snipped above.

[pennstatephil]

@MichalBernhard here's a copy: web.archive.org/web/20150317165438/http://groovy.codehaus.or‌​g/…