◀Table of Contents

Installation on macOS Platforms

GraalVM Community Edition can be installed for a single user and administrator privileges are not required. However, if GraalVM is meant to become a default JDK, administrator privileges are required.

GraalVM Community Edition does not provide the installation wizard, unlike OpenJDK distributions for macOS that come with the .dmg download. It can be installed from an archive file (.tar.gz). Note that in macOS, the JDK installation path is: /Library/Java/JavaVirtualMachines/<graalvm>/Contents/Home.

Follow these steps to install GraalVM Community on the macOS operating system:

1. Navigate to GraalVM Releases repository on GitHub. Select Java 11 based or Java 17 based distribution for macOS, and download.
2. Unzip the archive.

   tar -xzf graalvm-ce-java<version>-darwin-amd64-<version>.tar.gz
   

   Alternatively, open the file in Finder.

   Note: If you are using macOS Catalina and later you may need to remove the quarantine attribute:

    sudo xattr -r -d com.apple.quarantine /path/to/graalvm
   

3. Move the downloaded package to its proper location, the /Library/Java/JavaVirtualMachines directory. Since this is a system directory, sudo is required:

     sudo mv graalvm-ce-java<version>-<version> /Library/Java/JavaVirtualMachines
   

   To verify if the move is successful and to get a list of all installed JDKs, run /usr/libexec/java_home -V.

4. There can be multiple JDKs installed on the machine. The next step is to configure the runtime environment:
   • Point the PATH environment variable to the GraalVM bin directory:

      export PATH=/Library/Java/JavaVirtualMachines/<graalvm>/Contents/Home/bin:$PATH
     

   • Set the JAVA_HOME environment variable to resolve to the GraalVM installation directory:

      export JAVA_HOME=/Library/Java/JavaVirtualMachines/<graalvm>/Contents/Home
     

5. To check whether the installation was successful, run the java -version command.

Optionally, you can specify GraalVM as the default JRE or JDK installation in your Java IDE.

For Oracle GraalVM Enterprise Edition users, find the installation instructions here.

Installation Notes

On JAVA_HOME Command

The information property file, Info.plist, is in the top level Contents folder. This means that GraalVM Enterprise participates in the macOS-specific /usr/libexec/java_home mechanism. Depending on other JDK installation(s) available, it is now possible that /usr/libexec/java_home -v1.8 returns /Library/Java/JavaVirtualMachines/<graalvm>/Contents/Home. You can run /usr/libexec/java_home -v1.8 -V to see the complete list of 1.8 JVMs available to the java_home command. This command sorts the JVMs in decreasing version order and chooses the top one as the default for the specified version. Within a specific version, the sort order appears to be stable but is unspecified.

Supported Functionalities

The base distribution of GraalVM Community Edition for macOS includes OpenJDK with the GraalVM compiler enabled. The base installation can be additionally extended with:

Tools/Utilities:

• Native Image – a technology to compile an application ahead-of-time into a native executable
• LLVM toolchain – a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime

Language runtimes:

• Java on Truffle
• JavaScript
• Node.js
• LLVM
• Python
• Ruby
• R
• Wasm

To assist a user with installation, GraalVM includes GraalVM Updater, a command line utility to install and manage additional functionalities. Proceed to the installation steps to add any necessary language runtime or utility from above to GraalVM.