Skip to content

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

marketplace

1.2 Self-installation

text
https://plugins.jetbrains.com/plugin/24463-debugtools
text
https://download.debug-tools.cc/DebugToolsIdeaPlugin.zip
sh
git clone https://github.com/future0923/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
text
https://github.com/future0923/debug-tools/releases
text
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.

2.1 JDK 8

2.1.1 Use the packaged JDK package directly

Download from github

https://github.com/future0923/debug-tools/releases/tag/dcevm-jdk-1.8.0_181

DebugTools official website download

2.1.2 Self-installation

Windows/Mac OS

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

java versiondownload by debug toolsdownload by github
1.8.0_181DCEVM-8u181-installer.jarDCEVM-8u181-installer.jar
1.8.0_172DCEVM-8u172-installer.jarDCEVM-8u172-installer.jar
1.8.0_152DCEVM-8u152-installer.jarDCEVM-8u152-installer.jar
1.8.0_144DCEVM-8u144-installer.jarDCEVM-8u144-installer.jar
1.8.0_112DCEVM-8u112-installer.jarDCEVM-8u112-installer.jar
1.8.0_92DCEVM-8u92-installer.jarDCEVM-8u92-installer.jar
1.8.0_74DCEVM-8u74-installer.jarDCEVM-8u74-installer.jar
1.8.0_66DCEVM-8u66-installer.jarDCEVM-8u66-installer.jar
1.8.0_51DCEVM-8u51-installer.jarDCEVM-8u51-installer.jar
1.8.0_45DCEVM-8u45-installer.jarDCEVM-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.

dcevm-installer.png

Linux

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

text
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 versiondownload by debug toolsdownload by github
>= 1.8.0_181libjvm181.solibjvm181.so
1.8.0_172libjvm172.solibjvm172.so
1.8.0_152libjvm152.solibjvm152.so
1.8.0_144libjvm144.solibjvm144.so
1.8.0_112libjvm112.solibjvm112.so
1.8.0_92libjvm92.solibjvm92.so
1.8.0_74libjvm74.solibjvm74.so
<= 1.8.0_66libjvm66.solibjvm66.so

2.2 JDK 11

trava-jdk-11-dcevm

Use trava-jdk-11-dcevm JDK to support hot deployment/hot reload.

JetBrainsRuntime

Using JetBrainsRuntime JDK can support hot deployment/hot reload.

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.

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.

text
https://download.debug-tools.cc/debug-tools-agent.jar
sh
git clone https://github.com/future0923/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
text
https://github.com/future0923/debug-tools/releases
text
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.

text
https://download.debug-tools.cc/debug-tools-boot.jar
sh
git clone https://github.com/future0923/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
text
https://github.com/future0923/debug-tools/releases
text
https://gitee.com/future94/debug-tools/releases