Running servers from the command line¶

JRebel comes bundled with 64 and 32 bit libraries for JVMs, intended for use with Windows, macOS and Linux. The agent libraries can be found in the lib folder.

Windows 64-bit JDK	`jrebel64.dll`
Windows 32-bit JDK	`jrebel32.dll`
Mac OS X 64-bit JDK	`libjrebel64.dylib`
Linux 64-bit JDK	`libjrebel64.so`
Linux 32-bit JDK	`libjrebel32.so`

Add the correct agent library to your server startup script using -agentpath:. Keep reading for specific application server instructions.

Tip

Using a JRebel IDE plugin? You have access to all these snippets from Help > JRebel > Configuration > Startup.

Supported application servers
Enabling JRebel for Tomcat and WildFly using the JRebel CLI commands

Supported application servers¶

Cargo Maven plugin¶

Windows 64-bit¶

Use the cargo.start.jvmargs JVM system property to add the following option:

mvn cargo:run -Dcargo.start.jvmargs="-agentpath:c:\path\to]\lib\jrebel64.dll"

Windows 32-bit¶

Use the cargo.start.jvmargs JVM system property to add the following option:

mvn cargo:run -Dcargo.start.jvmargs="-agentpath:c:\path\to]\lib\jrebel32.dll"

macOS 64-bit¶

Use the cargo.start.jvmargs JVM system property to add the following option:

mvn cargo:run -Dcargo.start.jvmargs="-agentpath:/path/to/lib/libjrebel64.dylib"

Linux 64-bit¶

Use the cargo.start.jvmargs JVM system property to add the following option:

mvn cargo:run -Dcargo.start.jvmargs="-agentpath:/path/to/lib/libjrebel64.so"

Linux 32-bit¶

Use the cargo.start.jvmargs JVM system property to add the following option:

mvn cargo:run -Dcargo.start.jvmargs="-agentpath:/path/to/lib/libjrebel32.so"

GlassFish 4.x and 5.x¶

Open the GlassFish Administration Console.
Access Configuration > JVM Settings > JVM Options.

Use the Add JVM Option button to insert the following:

Windows 64-bit JDK	`-agentpath:[c:\path\to]\lib\jrebel64.dll`
Windows 32-bit JDK	`-agentpath:[c:\path\to]\lib\jrebel32.dll`
Mac OS X 64-bit JDK	`-agentpath:[path/to]/lib/libjrebel64.dylib`
Linux 64-bit JDK	`-agentpath:[path/to]/lib/libjrebel64.so`
Linux 32-bit JDK	`-agentpath:[path/to]/lib/libjrebel32.so`

Click Save and restart the server.

Gradle Java plugins¶

For the Gradle Application plugin, use run tasks’s jvmArgs property to add the following JVM option:

taskName.jvmArgs += '-agentpath:c:\path\to]\lib\jrebel64.dll'

In general, JRebel JVM arguments must be added to Gradle tasks of type ‘JavaExec’. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec) {
            task.jvmArgs += '-agentpath:c:\path\to]\lib\jrebel64.dll'
        }
    }
}

In some cases, for example, Spring Boot 3, certain tasks may need to be excluded. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec && !["processAot"].contains(task.name)) {
            task.jvmArgs += '-agentpath:c:\path\to]\lib\jrebel64.dll'
        }
    }
}

For the Gradle Application plugin, use run tasks’s jvmArgs property to add following JVM option:

taskName.jvmArgs += '-agentpath:c:\path\to]\lib\jrebel32.dll'

In general, JRebel JVM arguments must be added to Gradle tasks of type ‘JavaExec’. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec) {
            task.jvmArgs += '-agentpath:c:\path\to]\lib\jrebel32.dll'
        }
    }
}

In some cases, for example, Spring Boot 3, certain tasks may need to be excluded. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec && !["processAot"].contains(task.name)) {
            task.jvmArgs += '-agentpath:c:\path\to]\lib\jrebel32.dll'
        }
    }
}

For the Gradle Application plugin, use run tasks’s jvmArgs property to add following JVM option:

taskName.jvmArgs += '-agentpath:/path/to/lib/libjrebel64.dylib'

In general, JRebel JVM arguments must be added to Gradle tasks of type ‘JavaExec’. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec) {
            task.jvmArgs += '-agentpath:/path/to/lib/libjrebel64.dylib'
        }
    }
}

In some cases, for example, Spring Boot 3, certain tasks may need to be excluded. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec && !["processAot"].contains(task.name)) {
            task.jvmArgs += '-agentpath:/path/to/lib/libjrebel64.dylib'
        }
    }
}

For the Gradle Application plugin, use run tasks’s jvmArgs property to add following JVM option:

taskName.jvmArgs += '-agentpath:/path/to/lib/libjrebel64.so'

In general, JRebel JVM arguments must be added to Gradle tasks of type ‘JavaExec’. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec) {
            task.jvmArgs += '-agentpath:/path/to/lib/libjrebel64.so'
        }
    }
}

In some cases, for example, Spring Boot 3, certain tasks may need to be excluded. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec && !["processAot"].contains(task.name)) {
            task.jvmArgs += '-agentpath:/path/to/lib/libjrebel64.so'
        }
    }
}

For the Gradle Application plugin, use run tasks’s jvmArgs property to add following JVM option:

taskName.jvmArgs += '-agentpath:/path/to/lib/libjrebel32.so'

In general, JRebel JVM arguments must be added to Gradle tasks of type ‘JavaExec’. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec) {
            task.jvmArgs += '-agentpath:/path/to/lib/libjrebel32.so'
        }
    }
}

In some cases, for example, Spring Boot 3, certain tasks may need to be excluded. Use the following JVM options in your project build.gradle file:

gradle.taskGraph.whenReady { taskGraph ->
    taskGraph.allTasks.each { task ->
        if (task instanceof org.gradle.api.tasks.JavaExec && !["processAot"].contains(task.name)) {
            task.jvmArgs += '-agentpath:/path/to/lib/libjrebel32.so'
        }
    }
}

JBoss EAP¶

Open %JBOSS_HOME%\bin.
Create the file standalone-jrebel.cmd with the following content:

@echo off
set REBEL_HOME=JRebel root folder.
set JAVA_OPTS=-agentpath:%REBEL_HOME%\lib\jrebel64.dll %JAVA_OPTS%
call "%~dp0\standalone.bat" %*

Use this file instead of standalone.bat to run JBoss with JRebel.

Warning

Any further customization to JAVA_OPTS inside the JBoss executable (default standalone.conf.bat) needs to be included in standalone-jrebel.cmd for JRebel to function correctly.

Open %JBOSS_HOME%\bin.
Create the file standalone-jrebel.cmd with the following content:

@echo off
set REBEL_HOME=JRebel root folder.
set JAVA_OPTS=-agentpath:%REBEL_HOME%\lib\jrebel32.dll %JAVA_OPTS%
call "%~dp0\standalone.bat" %*

Use this file instead of standalone.bat to run JBoss with JRebel.

Warning

Any further customization to JAVA_OPTS inside the JBoss executable (default standalone.conf.bat) needs to be included in standalone-jrebel.cmd for JRebel to function correctly.

Open $JBOSS_HOME/bin.
Create the file standalone-jrebel.sh with the following content:

#!/bin/bash
export REBEL_HOME=JRebel root folder.
export JAVA_OPTS="-agentpath:$REBEL_HOME/lib/libjrebel64.dylib $JAVA_OPTS"
`dirname $0`/standalone.sh $@

Use this script instead of standalone.sh to run JBoss with JRebel.

Warning

Any further customization to JAVA_OPTS inside the JBoss executable (default standalone.conf.sh) needs to be included in standalone-jrebel.sh for JRebel to function correctly.

Open $JBOSS_HOME/bin.
Create the file standalone-jrebel.sh with the following content:

#!/bin/bash
export REBEL_HOME=JRebel root folder.
export JAVA_OPTS="-agentpath:$REBEL_HOME/lib/libjrebel64.so $JAVA_OPTS"
`dirname $0`/standalone.sh $@

Use this script instead of standalone.sh to run JBoss with JRebel.

Warning

Any further customization to JAVA_OPTS inside the JBoss executable (default standalone.conf.sh) needs to be included in standalone-jrebel.sh for JRebel to function correctly.

Open $JBOSS_HOME/bin.
Create the file standalone-jrebel.sh with the following content:

#!/bin/bash
export REBEL_HOME=JRebel root folder.
export JAVA_OPTS="-agentpath:$REBEL_HOME/lib/libjrebel32.so $JAVA_OPTS"
`dirname $0`/standalone.sh $@

Use this script instead of standalone.sh to run JBoss with JRebel.

Warning

Any further customization to JAVA_OPTS inside the JBoss executable (default standalone.conf.sh) needs to be included in standalone-jrebel.sh for JRebel to function correctly.

Jetty 9.x¶

Jetty does not provide startup scripts for Windows. Add the following to the command line:

-agentpath:[c:\path\to\]lib\jrebel64.dll

Jetty does not provide startup scripts for Windows. Add the following to the command line:

-agentpath:[c:\path\to\]lib\jrebel32.dll

Open $JETTY_HOME/bin.
Create the file run-jrebel.sh with the following content:

#!/bin/bash
export REBEL_HOME=JRebel root folder.
export JAVA_OPTIONS="-agentpath:$REBEL_HOME/lib/libjrebel64.dylib $JAVA_OPTIONS"
`dirname $0`/jetty.sh $@

Use this script instead of jetty.sh to run Jetty with JRebel.

Open $JETTY_HOME/bin.
Create the file run-jrebel.sh with the following content:

#!/bin/bash
export REBEL_HOME=JRebel root folder.
export JAVA_OPTIONS="-agentpath:$REBEL_HOME/lib/libjrebel64.so $JAVA_OPTIONS"
`dirname $0`/jetty.sh $@

Use this script instead of jetty.sh to run Jetty with JRebel.

Open $JETTY_HOME/bin.
Create the file run-jrebel.sh with the following content:

#!/bin/bash
export REBEL_HOME=JRebel root folder.
export JAVA_OPTIONS="-agentpath:$REBEL_HOME/lib/libjrebel32.so $JAVA_OPTIONS"
`dirname $0`/jetty.sh $@

Use this script instead of jetty.sh to run Jetty with JRebel.

Maven Jetty plugin (mvn jetty:run)¶

To disable Jetty’s internal reloading, open the pom.xml file and set the scanIntervalSeconds parameter to 0. The updated pom.xml file should look like this:

<plugin>
 <groupId>org.eclipse.jetty</groupId>
 <artifactId>jetty-maven-plugin</artifactId>
 <configuration>
   <scanIntervalSeconds>0</scanIntervalSeconds>
 </configuration>
</plugin>

Add the following to the MAVEN_OPTS environment variable:

-agentpath:[c:\path\to\]lib\jrebel64.dll