Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>These instructions describe how to install a binary distribution of <strong>Groovy</strong>.</p>

<ul>
	<li>first, <a class="confluence-link" href="/display/GROOVY/Download" data-linked-resource-id="2742" data-linked-resource-type="page" data-linked-resource-default-alias="Download" data-base-url="http://docs.codehaus.org">Download</a> a binary distribution of Groovy and unpack it into some file on your local file system</li>
	<li>set your <em>GROOVY_HOME</em> environment variable to the directory you unpacked the distribution</li>
	<li>add <em>GROOVY_HOME</em>/bin to your <em>PATH</em> environment variable</li>
	<li>set your <em>JAVA_HOME</em> environment variable to point to your JDK. On OS X this is /Library/Java/Home, on other unixes its often /usr/java etc. If you've already installed tools like Ant or Maven you've probably already done this step.</li>
</ul>

<p>You should now have Groovy installed properly. You can test this by typing the following in a command shell:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
groovysh
</pre></td></tr></table>
<p>Which should create an interactive groovy shell where you can type Groovy statements. Or to run the <a class="confluence-link" href="/display/GROOVY/Groovy+Console" data-linked-resource-id="36800" data-linked-resource-type="page" data-linked-resource-default-alias="Groovy Console" data-base-url="http://docs.codehaus.org">Swing interactive console</a> type:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
groovyConsole
</pre></td></tr></table>
<p>To run a specific Groovy script type:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
groovy SomeScript.groovy
</pre></td></tr></table>
<p><strong>Alternative Installation on Mac OS X</strong></p>

<p>Set up <a href="http://www.macports.org/">MacPorts</a></p>

<p>Open Terminal</p>

<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
sudo port install groovy
</pre></td></tr></table>