graal/tools
Doug Simon c1f0b9f252 add missing requiresConcealed entries for JVMCI packages 2024-10-10 12:44:33 +02:00
..
ci fix jobs that are missing defined_in 2024-03-17 20:47:23 +01:00
docs Moved tools/docs/Insight.md to its old location 2022-02-09 14:26:36 +02:00
generators [GR-46205] Shaded org.json library. 2023-07-19 13:16:39 +02:00
mx.tools add missing requiresConcealed entries for JVMCI packages 2024-10-10 12:44:33 +02:00
src LSPLibrary corrections and tests. (GR-58479) 2024-09-25 18:54:30 +02:00
CHANGELOG.md Added --inspect.SuspensionTimeout option. (GR-54751) 2024-06-28 18:32:57 +02:00
LICENSE Harmonize different version of GPLv2+CPE 2020-02-18 14:21:35 +01:00
OWNERS.toml Add tools owners. 2024-05-10 10:00:47 +02:00
README.md Replace GRAALVM_HOME with JAVA_HOME in graal/docs 2023-02-06 16:16:04 +02:00
VISUALVM_LICENSE Add a license file to the VisualVM installable. 2022-06-17 17:29:42 +02:00

README.md

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., $JAVA_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 graal-dev@openjdk.java.net 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.