Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.66 KB

README.md

File metadata and controls

54 lines (40 loc) · 1.66 KB
Raw

GraalVM Tools

This tools suite provides tooling support for guest languages running on GraalVM. It depends on Truffle and is language-agnostic. The tools are available to be used with any language built with Truffle and passing TCK tests.

Using Tools

Please refer to https://www.graalvm.org/tools/ to learn how to use each tool. The tools in this suite have options that can be specified to command-line language launchers, which can be listed via --help:tools (e.g., $GRAALVM_HOME/bin/polyglot --help:tools). Some tools provide additional APIs.

Setup and Build

Tools can be built with the MX build tool, which must be downloaded and put onto your PATH. Make sure that your JAVA_HOME points to a JVMCI-enabled JDK such as labs-openjdk-11.

$ git clone https://github.com/graalvm/mx.git
$ export PATH=$PWD/mx:$PATH
$ git clone https://github.com/graalvm/graal.git
$ cd graal/tools
$ mx build
$ mx unittest

IDE Configuration

You can generate IDE project configurations by running:

$ mx ideinit

This will generate Eclipse, IntelliJ, and NetBeans project configurations.

Contributing

You can contact the Truffle developers at [email protected] mailing list. To contribute a change, verify it using

$ mx gate

and start a pull request.

License

The tools are is licensed under the GPL 2 with Classpath Exception.