Main Content

webapps-runtime

Configure MATLAB Runtime for use with MATLAB Web App Server from the command line on Windows, Linux, and macOS systems

Since R2020a

collapse all in page

Syntax

webapps-runtime list
webapps-runtime add runtime_path
webapps-runtime remove
webapps-runtime remove runtime_path
webapps-runtime [--version | -v]
webapps-runtime [--help | -h]

Description

webapps-runtime list returns the list of currently configured versions of MATLAB® Runtime.

webapps-runtime add runtime_path adds the path to a MATLAB Runtime installation, specified by runtime_path, to the server configuration.

webapps-runtime remove starts an interactive prompt to remove paths to MATLAB Runtime installations from the server configuration.

webapps-runtime remove runtime_path removes the path to a MATLAB Runtime installation, specified by runtime_path, from the server configuration.

webapps-runtime [--version | -v] returns the version of MATLAB Web App Server™ that is installed.

webapps-runtime [--help | -h] returns command-line help.

Examples

List MATLAB Runtime Installations

To get a list of MATLAB Runtime configured for use with the server, at the system command line, type:

webapps-runtime list
C:\Program Files\MATLAB\MATLAB Runtime\v241
/usr/local/MATLAB/MATLAB_Runtime/v241

Add MATLAB Runtime Path

To add the path to a MATLAB Runtime installation to the server configuration, at the system command line, type:

webapps-runtime add "C:\Program Files\MATLAB\MATLAB Runtime\v98"
MATLAB Runtime configuration updated. Changes will be applied the next time the server is started.

Remove MATLAB Runtime Path

To remove the path to a MATLAB Runtime installation from the server configuration, at the system command line, type:

webapps-runtime remove "C:\Program Files\MATLAB\MATLAB Runtime\v98"
MATLAB Runtime configuration updated. Changes will be applied the next time the server is started.

Get Version of MATLAB Web App Server

To get the version of MATLAB Web App Server that is installed, at the system command line, type:

webapps-runtime --version
MATLAB Web App Server (R2024a Release)

Get Command-Line Help

To get help for the current command, at the system command line, type:

webapps-runtime --help
Usage:
  webapps-runtime -h [ --help ]          Display this help message
  webapps-runtime -v [ --version ]       Display the version of MATLAB Web App Server
  webapps-runtime list                   Lists currently configured MATLAB Runtimes
  webapps-runtime add <runtime-path>     Adds runtime-path to the MATLAB Runtime configuration
  webapps-runtime remove                 Launch interactive prompt to remove MATLAB Runtimes 
                                         from the from the MATLAB Runtime configuration
  webapps-runtime remove <runtime-path>  Removes runtime-path from the MATLAB Runtime configuration

Input Arguments

collapse all

Specify the path to the MATLAB Runtime installation that you want to add to the server configuration or remove from the server configuration.

Example: "C:\Program Files\MATLAB\MATLAB Runtime\R2024a"

More About

collapse all

MATLAB Web App Server Command-Line Script Location

The command-line scripts are located in the script folder in your MATLAB Web App Server installation folder. For instance, the default locations for R2024a are as follows:

Operating SystemDefault Location of Command-Line Scripts

Windows® (Administrator)

C:\Program Files\MATLAB\MATLAB Web App Server\R2024a\script

Linux® (sudo)

/usr/local/MATLAB/MATLAB_Web_App_Server/R2024a/script

macOS (Intel® processor) (sudo)

/Applications/MATLAB/MATLAB_Web_App_Server/R2024a/script

Version History

Introduced in R2020a

See Also

| |

Topics