Please refer to the GraalVM website for documentation. 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.
- Open a GitHub issue for bug reports, questions, or requests for enhancements.
- Join the GraalVM Slack to connect with the community and the GraalVM team.
- Report a security vulnerability according to the Reporting Vulnerabilities guide.
This source repository is the main repository for GraalVM and includes the following components:
||Configuration files for GitHub issues, workflows, ….|
||Graal compiler, a modern, versatile compiler written in Java.|
||Espresso, a meta-circular Java bytecode interpreter for the GraalVM.|
||TRegex, a regular expression engine for other GraalVM languages.|
||GraalVM SDK, long-term supported APIs of GraalVM.|
||Framework for ahead-of-time (AOT) compilation with Native Image.|
||Sulong, an engine for running LLVM bitcode on GraalVM.|
||Tools for GraalVM languages implemented with the instrumentation framework.|
||GraalVM's language implementation framework for creating languages and tools.|
||Components for building GraalVM distributions.|
||GraalWasm, an engine for running WebAssembly programs on GraalVM.|
GraalVM provides additional languages, tools, and other components developed in related repositories. These are:
|FastR||Implementation of the R language.|
|GraalPython||Implementation of the Python language.|
|GraalVM Demos||Several example applications illustrating GraalVM capabilities.|
|Native Build Tools||Build tool plugins for GraalVM Native Image.|
|SimpleLanguage||A simple example language built with the Truffle framework.|
|SimpleTool||A simple example tool built with the Truffle framework.|
|TruffleRuby||Implementation of the Ruby language.|
|VS Code Extensions||VS Code extensions for GraalVM.|
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). GraalVM Community is free to use for any purpose - no strings attached.
|GraalVM Compiler, SubstrateVM, Tools, VM||GPL 2 with Classpath Exception|
|GraalVM SDK, GraalWasm, Truffle Framework, TRegex||Universal Permissive License|