Quick Start Guide

By IDE Standalone
VSCode

VS Code

1. Installation

  1. Go to Extensions in VS Code. (View -> Extensions)
  2. Search JRebel.
  3. Click Install.
  4. Accept terms.

Did this work?

If the installation was a success, your IDE will prompt a restart. After the restart, JRebel will be available to you in the left toolbar.

2. Activation

  1. Click JRebel view in left dashboard.
  2. Click Dashboard
  3. In Licenses section, Click “Add License”

Have a License?

Press I already have a license in the activation window.

  • Activation code. Paste your activation code if you have one already.
  • License file from the hard drive. Point to your jrebel.lic  jrebel.lic file. You get this file via email when you purchase JRebel.
  • Connect to ZeroTurnaround License Management or an on-premises License Server. Enter your team URL and email. You get the team URL from your network administrator.

Don't Have a License?

Click “Individual Trial.”

  • Fill in information requested.
  • Accept terms and click OK.
  • Trial license distributed to your machine.

3. Project Configuration

  1. Open JRebel view (View -> Open View -> Search “JRebel”) and Click “Go to Projects”.

  2. Select the JRebel IDE icon check box (see image below) for each project that you want to add JRebel to. This will generate rebel.xml and keep it up to date.

    JRebel IDE icon
  3. Redeploy your application (or restart your standalone application).

Didn't Work?

Did This Work?

When building your application, rebel.xml should be included within the application archive. 

  • In case of JAR files, rebel.xml should be included in the root folder.
  • When working with WAR files, the rebel.xml should be located within the WEB-INF/classes folder.
  • EAR files require a rebel.xml for each internal EAR module (that means JARs and WARs).

4. Startup Configuration

How do you run your server?

  • Via IDE
  • Locally from command line
  • On a remote server

Run via IDE

  • Open JRebel view (View -> Open View -> Search “JRebel”).
  • Click Startup – Guide.
  • Click “Run via IDE”.
  • Select the check-box next to your application server. Doing this will automatically run it with the required JVM arguments.

Good to know

Not running your server from the IDE? Follow another application server startup method.

Did this work?

When successful, you will see the JRebel banner in the console right at server startup. This is what the JRebel banner should look like:

2016-11-15 12:19:20 JRebel:  #############################################################
2016-11-15 12:19:20 JRebel:  
2016-11-15 12:19:20 JRebel:  JRebel Agent 7.0.0 (201611081555)
2016-11-15 12:19:20 JRebel:  (c) Copyright ZeroTurnaround AS, Estonia, Tartu.
2016-11-15 12:19:20 JRebel:  
2016-11-15 12:19:20 JRebel:  Over the last 1 days JRebel prevented
2016-11-15 12:19:20 JRebel:  at least 0 redeploys/restarts saving you about 0 hours.
2016-11-15 12:19:20 JRebel:  
2016-11-15 12:19:20 JRebel:  Licensed to ZeroTurnaround.
2016-11-15 12:19:20 JRebel:  
2016-11-15 12:19:20 JRebel:  #############################################################

5. Reload Your Code

  1. Restart your application server or Java application.
  2. Change something in the application code.
  3. Make sure to compile updates made in code.
  4. Refresh the application in the browser to see the changes!

Learn More From JRebel Documentation

View Docs