matlab_jenv

Set the Java path for MATLAB from system prompt

Since R2021b

Syntax

matlab_jenv version

matlab_jenv -clear

matlab_jenv -allusers ___

matlab_jenv -help

Description

matlab_jenv version sets the Java^® path for MATLAB^® to a Java version on your system or the version in a specified folder. For supported version information, see Versions of OpenJDK Compatible with MATLAB by Release. For more information, see Configure Your System to Use Java.

The matlab_jenv command does not start MATLAB. To use MATLAB, start MATLAB at the same system prompt where you set the path variable.

This command sets the path for all future MATLAB sessions but does not change the path for other applications on your computer.

matlab_jenv -clear removes the JRE™ configuration for an individual user. Use this option after installing the MATLAB Support for OpenJDK^® add-on. (since R2026a)

When you clear the JRE configuration, MATLAB looks for the JRE in this order:

1. Location of the MATLAB Support for OpenJDK add-on.

2. Depending on your operating system:

   • For Windows^® and Linux^®, the version of Java shipped with MATLAB.

   • For Apple silicon, the system-installed Java.

matlab_jenv -allusers ___ updates the JRE configuration for all users of the MATLAB installation. Use this syntax with any of the input argument combinations in previous syntaxes.

matlab_jenv -help displays command usage and syntax information in the system prompt.

Examples

Use Specific Version of Installed Java

Use the version of Java installed at C:\Program Files\Java\jre1.8.0_202.

matlab_jenv "C:\Program Files\Java\jre1.8.0_202"

Start MATLAB to use the updated path.

Then, verify the version.

version -java

Set Java Path for All Users at Installation

After installing MATLAB, a system administrator can set the Java path for all users.

Use the system value for the installed MATLAB. With administrative privileges, at the operating system prompt, type:

matlab_jenv -allusers system

Verify the version. Start MATLAB and type:

version -java

Input Arguments

version — Java version

string scalar | character vector

Java version, specified as a string scalar or character vector that contains one of these values:

• "system" — The function searches your system for Java version 8. If version 8 is not found, the function searches for version 11, then for version 17. The search is based on platform.

  • Windows platforms:

    1. java -version system command

    2. Registry entries

  • Linux platforms:

    1. JAVA_HOME environment variable

    2. System path

  • macOS platforms:

    1. /usr/libexec/java_home -f -v 1.8

    2. /usr/libexec/java_home -f -v 11

    3. /usr/libexec/java_home -f -v 17

• Custom Java path — Specify the folder for an installed Java version on your computer.

For version information, see Versions of OpenJDK Compatible with MATLAB by Release.

Example: matlab_jenv system

Tips

• To use the OpenJDK JRE, you can either install the MATLAB Support for OpenJDK add-on or download a compatible OpenJDK version from https://adoptium.net.

Version History

Introduced in R2021b

R2026a: Configure JRE for MATLAB Support for OpenJDK add-on

After installing the MATLAB Support for OpenJDK add-on, call matlab_jenv with the -clear option to configure the JRE. You can configure the JRE for an individual user or for each MATLAB installation for all users. To install the add-on, see Install and Configure OpenJDK using MATLAB Add-On.

R2026a: "factory" option to be removed

When you call matlab_jenv with the Java version set to "factory", MATLAB sets the path to the Java version included with MATLAB. In a future release, MATLAB will no longer include Java by default and the version argument value "factory" will be removed.

R2023a: Display environment information

The command displays Java environment information at the operating system prompt, but it does not return the information.