(Quick Reference)

3 Installation

Version: 2023.3.0

3 Installation

Please follow these instructions in order to complete your installation.

Prerequisites

Grace CLI requires Java JDK v17.0 or above in order to run. Groovy v4.0.x is packaged as part of this distribution, and therefore does not need to be installed (any existing Groovy installation is ignored).

Grace CLI will use whatever JDK it finds on your path, to check that you have an appropriate version you should run:

$ java -version

Alternatively, you can set the JAVA_HOME environment variable to point a suitable JDK.

Environment Variables

No specific environment variables are required to run the CLI, however, you may want to set GRACE_HOME to point to a specific installation. You should also add GRACE_HOME/bin to your PATH environment variable.

Checking Your Installation

To test if you have successfully installed the CLI you can run the following command:

$ grace -v

If you see the output like below, congratulations, you have installed it successfully.

------------------------------------------------------------
Grace {version}
------------------------------------------------------------

Build time:   2025-06-22 13:30:19 UTC
Revision:     ba9b75634a9c2e79e0612d93df9c9fc81d05dd74

Spring Boot:  3.3.13
Gradle:       8.14.2
Groovy:       4.0.27
JVM:          17.0.15 (BellSoft 17.0.15+10-LTS)
OS:           Mac OS X 12.7.6 aarch64