Installation instructions

1. Install the plugin

1.1 Marketplace store (recommended)

1. Open IDE Settings and select Plugins

2. Search DebugTools in Marketplace and click install

3. Restart the application

1.2 Self-installation

Store URL

https://plugins.jetbrains.com/plugin/24463-debugtools

Offline installation

https://download.debug-tools.cc/DebugToolsIdeaPlugin.zip

Manual build

git clone https://github.com/java-hot-deploy/debug-tools.git
cd debug-tools
# Maven packaging needs to use `java17+` version to build
mvn clean install -T 2C -Dmaven.test.skip=true
# In the dist directory
# debug-tools-boot.jar remote agent package
cd debug-tools-idea
# When grade packages the Idea plug-in, it needs to use the `java17+` version to build
./gradlew clean buildPlugin
# In the dist directory
# DebugTools-{version}.zip IDEA plug-in package

github

https://github.com/java-hot-deploy/debug-tools/releases

gitee

https://gitee.com/future94/debug-tools/releases

2. Install JDK

Specific JDK support is only required when using the hot-deploy and hot-reload functions.

To simplify the hot deployment installation steps, Linux supports one-click installation, using the following command:

wget https://download.debug-tools.cc/install/linux-install.tar.gz -O linux-install.tar.gz && tar zxf linux-install.tar.gz && cd linux-install && ./install.sh

Installation location.

• jdk: /usr/local/java
• debug-tools: /usr/local/debug-tools

2.1 JDK 8

2.1.1 Use the packaged JDK package directly （Recommend）

Download from github

https://github.com/java-hot-deploy/debug-tools/releases/tag/dcevm-jdk-1.8.0_181

• windows-jdk-8u181.zip
• mac-x64-jdk-8u181.zip
• mac-aarch64-jdk-8u282.zip
• linux-x64-jdk-8u181.tar.gz

DebugTools official website download

• windows-jdk-8u181.zip
• mac-x64-jdk-8u181.zip
• mac-aarch64-jdk-8u282.zip
• linux-x64-jdk-8u181.tar.gz

TIP

• Currently, there is no native JDK for the DCEVM chip on Mac OS. The JDK provided above is modified using adopt jdk and is still essentially an x86 architecture JDK.
• If your project allows, we strongly recommend using JetBrains Runtime 11+.

2.1.2 Self-installation

Windows/Mac OS (intel)

Download the corresponding version of the .jar file. Currently only the following versions of JDK are supported, please select the corresponding version.

java version	download by debug tools	download by github
1.8.0_181	DCEVM-8u181-installer.jar	DCEVM-8u181-installer.jar
1.8.0_172	DCEVM-8u172-installer.jar	DCEVM-8u172-installer.jar
1.8.0_152	DCEVM-8u152-installer.jar	DCEVM-8u152-installer.jar
1.8.0_144	DCEVM-8u144-installer.jar	DCEVM-8u144-installer.jar
1.8.0_112	DCEVM-8u112-installer.jar	DCEVM-8u112-installer.jar
1.8.0_92	DCEVM-8u92-installer.jar	DCEVM-8u92-installer.jar
1.8.0_74	DCEVM-8u74-installer.jar	DCEVM-8u74-installer.jar
1.8.0_66	DCEVM-8u66-installer.jar	DCEVM-8u66-installer.jar
1.8.0_51	DCEVM-8u51-installer.jar	DCEVM-8u51-installer.jar
1.8.0_45	DCEVM-8u45-installer.jar	DCEVM-8u45-installer.jar

Run the corresponding java -jar DCEVM-8uXX-installer.jar file, find the corresponding version, and click the Install DCEVM as altjvm button.

Linux

If you enter java -XXaltjvm=dcevm -version, you will get the following prompt

Error: missing `dcevm' JVM at `/home/java/jdk1.8.0_291/jre/lib/amd64/dcevm/libjvm.so'.
Please install or use the JRE or JDK that contains these missing components.

Download the corresponding version file and rename it to libjvm.so and put it in the directory extracted above.

java version	download by debug tools	download by github
>= 1.8.0_181	libjvm181.so	libjvm181.so
1.8.0_172	libjvm172.so	libjvm172.so
1.8.0_152	libjvm152.so	libjvm152.so
1.8.0_144	libjvm144.so	libjvm144.so
1.8.0_112	libjvm112.so	libjvm112.so
1.8.0_92	libjvm92.so	libjvm92.so
1.8.0_74	libjvm74.so	libjvm74.so
<= 1.8.0_66	libjvm66.so	libjvm66.so

2.2 JDK 11

JetBrainsRuntime

Using JetBrainsRuntime JDK can support hot deployment/hot reload.

Please download the SDK version with JBR with JCEF (DCEVM) or JBR with JCEF (fastdebug).

It is recommended to use the latest version 11_0_15-b2043.56

2.3 JDK 17/21

Using JetBrainsRuntime JDK can support hot deployment/hot reload.

Please download the SDK version with JBRSDK with JCEF.

For Java 17, we recommend using the latest version 17.0.14b1367.22

For Java 21, we recommend using the latest version

You can also download the JDK in Project Structure and select JetBrains Runtime (JCEF)

INFO

If the Apple system prompts that the JDK is damaged or the developer cannot be verified after downloading the JDK, you can enter sudo xattr -r -d com.apple.quarantine /$jdkPath, $jdkPath is your jdk directory

3. Download debug-tools-agent.jar

debug-tools-agent.jar is a Java Agent package, which is the core of DebugTools functions. DebugTools functions are all implemented through Java Agent.

Only hot-deploy requires this jar, and the others are already built into the Idea plugin.

URL

https://download.debug-tools.cc/debug-tools-agent.jar

Manual build

git clone https://github.com/java-hot-deploy/debug-tools.git
cd debug-tools
# Currently, maven packaging needs to be built using the `java17+` version.
mvn clean install -T 2C -Dmaven.test.skip=true
# In the dist directory
# debug-tools-agent.jar remote agent package

github

https://github.com/java-hot-deploy/debug-tools/releases

gitee

https://gitee.com/future94/debug-tools/releases

4. Download debug-tools-boot.jar

Use debug-tools-boot.jar to dynamically start the debug tools server service after the application starts.

URL

https://download.debug-tools.cc/debug-tools-boot.jar

Manual build

git clone https://github.com/java-hot-deploy/debug-tools.git
cd debug-tools
# Currently, maven packaging needs to be built using the `java17+` version.
mvn clean install -T 2C -Dmaven.test.skip=true
# In the dist directory
# debug-tools-boot.jar remote agent package

github

https://github.com/java-hot-deploy/debug-tools/releases

gitee

https://gitee.com/future94/debug-tools/releases