graal – oracle

![GraalVM][website]

[![GraalVM downloads][badge-dl]][downloads] [![GraalVM docs][badge-docs]][docs] [![GraalVM on Slack][badge-slack]][slack] [![GraalVM Gate][badge-gate]][gate] [![License][badge-license]](#license) [![GraalVM on LinkedIn][badge-linkedin]][social-linkedin] [![GraalVM on X][badge-x]][social-x] [![GraalVM on Bluesky][badge-bluesky]][social-bluesky] [![GraalVM on Medium][badge-medium]][social-medium] [![GraalVM on YouTube][badge-yt]][social-youtube]

GraalVM compiles applications ahead of time into standalone binaries that start instantly, provide peak performance with no warmup, and use fewer resources.
You can use GraalVM just like any other Java Development Kit in your IDE.

The project website at [https://www.graalvm.org/][website] describes how to [get started][getting-started], how to [stay connected][community], and how to [contribute][contributors].

Documentation

Please refer to the [GraalVM website for documentation][docs].
You can find most of the documentation sources in the _docs/_ directory in the same hierarchy as displayed on the website.
Additional documentation including developer instructions for individual components can be found in corresponding _docs/_ sub-directories.
The documentation for the Truffle framework, for example, is in _truffle/docs/_.
This also applies to languages, tools, and other components maintained in related repositories.
Instructions for building GraalVM from source are in <code class="ra0-md-code">vm/README.md</code>.

Get Support

• Open a [GitHub issue][issues] for reproducible bugs and concrete feature requests.
• Use GitHub Discussions or join the [GraalVM Slack][slack] for questions, design discussion, and general community support.
• Read the contribution guide before opening a pull request.
• Report security vulnerabilities according to the [Reporting Vulnerabilities guide][reporting-vulnerabilities], not in public issues.

Repository Structure

This source repository is the main repository for GraalVM and includes the following components:

Directory | Description
------------ | -------------
<code class="ra0-md-code">.github/</code> | Configuration files for GitHub issues, workflows, ….
<code class="ra0-md-code">ci/</code> | Configuration files for internal CI/CD infrastructure.
<code class="ra0-md-code">ci_includes/</code> | Configuration include files for internal CI/CD infrastructure.
<code class="ra0-md-code">compiler/</code> | [Graal compiler][reference-compiler], a modern, versatile compiler written in Java.
<code class="ra0-md-code">espresso-compiler-stub/</code> | A dummy GraalJVMCICompiler implementation for Espresso.
<code class="ra0-md-code">espresso-shared/</code> | Espresso shared code for runtime class loading.
<code class="ra0-md-code">espresso/</code> | [Espresso][java-on-truffle], a meta-circular Java bytecode interpreter for the GraalVM.
<code class="ra0-md-code">regex/</code> | TRegex, a regular expression engine for other GraalVM languages.
<code class="ra0-md-code">sdk/</code> | [GraalVM SDK][graalvm-sdk], long-term supported APIs of GraalVM.
<code class="ra0-md-code">substratevm/</code> | Framework for ahead-of-time (AOT) compilation with [Native Image][native-image].
<code class="ra0-md-code">sulong/</code> | [Sulong][reference-sulong], an engine for running LLVM bitcode on GraalVM.
<code class="ra0-md-code">tools/</code> | Tools for Graal Languages implemented with the instrumentation framework.
<code class="ra0-md-code">truffle/</code> | [Language implementation framework][truffle] for creating languages and tools.
<code class="ra0-md-code">visualizer/</code> | [Ideal Graph Visualizer (IGV)][igv], a tool for analyzing Graal compiler graphs.
<code class="ra0-md-code">vm/</code> | Components for building GraalVM distributions.
<code class="ra0-md-code">wasm/</code> | [GraalWasm][reference-graalwasm], an engine for running WebAssembly programs on GraalVM.
<code class="ra0-md-code">web-image/</code> | Web Image, an experimental WebAssembly backend for Native Image.

Related Repositories

GraalVM provides additional languages, tools, and other components developed in related repositories. These are:

Name | Description
------------ | -------------
[GraalJS] | Implementation of JavaScript and Node.js.
[GraalPy] | Implementation of the Python language.
[graalvm-reachability-metadata] | Reachability metadata for open-source libraries.
[Native Build Tools][native-build-tools] | Build tool plugins for GraalVM Native Image.
[setup-graalvm] | GitHub Action for GraalVM.
[SimpleLanguage] | A simple example language built with the Truffle framework.
[SimpleTool] | A simple example tool built with the Truffle framework.

Examples and Tutorials

Explore practical examples, deep-dive workshops, and language-specific demos for working with GraalVM.

Name | Description
------------ | -------------
[GraalVM Demos][graalvm-demos] | Example applications highlighting GraalVM key features and best practices.
[GraalVM Workshops and Tutorials][graalvm-workshops] | Workshops and tutorials to help you learn and apply GraalVM tools and capabilities.
[Graal Languages - Demos and Guides][graal-languages-demos] | Demo applications and guides for GraalJS, GraalPy, GraalWasm, and other Graal Languages.

License

GraalVM Community Edition is open source and distributed under version 2 of the GNU General Public License with the “Classpath” Exception, which are the same terms as for Java. The licenses of the individual GraalVM components are generally derivative of the license of a particular language (see the table below).

Component(s) | License
------------ | -------------
Espresso, Ideal Graph Visualizer, Web Image | GPL 2
GraalVM Compiler, SubstrateVM, Tools, VM | GPL 2 with Classpath Exception
GraalVM SDK, GraalWasm, Truffle Framework, TRegex | Universal Permissive License
Sulong | 3-clause BSD

[badge-bluesky]: https://img.shields.io/badge/-grey?logo=bluesky&logoColor=f5f5f5
[badge-dl]: https://img.shields.io/badge/download-latest-blue
[badge-docs]: https://img.shields.io/badge/docs-read-active
[badge-gate]: https://img.shields.io/github/actions/workflow/status/oracle/graal/main.yml
[badge-license]: https://img.shields.io/badge/license-GPLv2+CE-active
[badge-linkedin]: https://custom-icon-badges.demolab.com/badge/-555?logo=linkedin-white&logoColor=fff
[badge-medium]: https://img.shields.io/badge/-grey?logo=medium
[badge-slack]: https://img.shields.io/badge/Slack-join-active
[badge-x]: https://img.shields.io/badge/-grey?logo=X
[badge-yt]: https://img.shields.io/badge/-grey?logo=youtube
[community]: https://www.graalvm.org/community/
[contributors]: https://www.graalvm.org/community/contributors/
[docs]: https://www.graalvm.org/latest/docs/
[downloads]: https://www.graalvm.org/downloads/
[gate]: https://github.com/oracle/graal/actions/workflows/main.yml
[getting-started]: https://www.graalvm.org/latest/docs/getting-started/
[graal-languages-demos]: https://github.com/graalvm/graal-languages-demos/
[graaljs]: https://github.com/oracle/graaljs
[graalpy]: https://github.com/oracle/graalpython
[graalvm-demos]: https://github.com/graalvm/graalvm-demos
[graalvm-reachability-metadata]: https://github.com/oracle/graalvm-reachability-metadata
[graalvm-sdk]: https://www.graalvm.org/sdk/javadoc/
[graalvm-workshops]: https://github.com/graalvm/workshops
[igv]: https://www.graalvm.org/latest/tools/igv/
[issues]: https://github.com/oracle/graal/issues
[java-on-truffle]: https://www.graalvm.org/latest/reference-manual/java-on-truffle/
[native-build-tools]: https://github.com/graalvm/native-build-tools
[native-image]: https://www.graalvm.org/native-image/
[reference-compiler]: https://www.graalvm.org/latest/reference-manual/java/compiler/
[reference-graalwasm]: https://www.graalvm.org/latest/reference-manual/wasm/
[reference-sulong]: https://www.graalvm.org/latest/reference-manual/llvm/
[reporting-vulnerabilities]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
[setup-graalvm]: https://github.com/graalvm/setup-graalvm
[simplelanguage]: https://github.com/graalvm/simplelanguage
[simpletool]: https://github.com/graalvm/simpletool
[slack]: https://www.graalvm.org/slack-invitation/
[social-bluesky]: https://bsky.app/profile/graalvm.org
[social-linkedin]: https://www.linkedin.com/company/graalvm/
[social-medium]: https://medium.com/graalvm
[social-x]: https://x.com/graalvm
[social-youtube]: https://www.youtube.com/graalvm
[truffle]: https://www.graalvm.org/graalvm-as-a-platform/language-implementation-framework/
[website]: https://www.graalvm.org/