matlab.addons.install

R2026b

(Not recommended) Install add-on

matlab.addons.install is not recommended. Use mpminstall instead. (since R2026b) For information on updating your code, see Version History.

Syntax

newAddon = matlab.addons.install(fileName)

newAddon = matlab.addons.install(fileName,installOption)

Description

newAddon = matlab.addons.install(fileName) installs the add-on specified by fileName. If a version of the add-on is already installed, MATLAB^® overwrites the previous version.

MATLAB installs the add-on in the default add-on installation folder. For more information including how to change the default add-on installation folder, see Get and Manage Add-Ons.

matlab.addons.install only supports installing toolboxes.

newAddon = matlab.addons.install(fileName,installOption) installs the add-on without overwriting previously installed versions if installOption is 'add'. Otherwise, if a version of the add-on is already installed, MATLAB overwrites the previous version.

Examples

Install Toolbox Without Overwriting Previous Versions

Suppose that you have version 2.0 of a toolbox called My Toolbox installed on your system. Install version 4.0 of the toolbox without overwriting version 2.0.

Assume that you have the 'My toolbox_v4.0.mltbx' toolbox file in your current working folder. Install the toolbox without overwriting the existing installed version by specifying that you want to add the toolbox.

toolboxFile = 'My toolbox_v4.0.mltbx';
installOption = 'add';
matlab.addons.install(toolboxFile, installOption)

ans =

  1×4 table

          Name           Version    Enabled                  Identifier              
    _________________    _______    _______    ______________________________________

    "My toolbox_v4.0"     "4.0"      true      "6de8682e-9c3c-407e-bad7-aa103d738d08"

If the toolbox contains a license agreement, a dialog box opens to prompt you to agree to the license before installation.

Verify that the previous version of the toolbox is still installed.

addons = matlab.addons.installedAddons

addons =

  2×4 table

             Name                   Version     Enabled                  Identifier              
    ___________________________    _________    _______    ______________________________________

    "My Toolbox_v4.0"              "4.0"         true      "6de8682e-9c3c-407e-bad7-aa103d738d08"
    "My Toolbox"                   "2.0"         false     "6de8682e-9c3c-407e-bad7-aa103d738d08"

Input Arguments

fileName — File name

character vector | string

File name to install, specified as a character vector or string. File name must be a valid toolbox installation file (*.mltbx). You can specify the file name as an absolute or relative path.

installOption — Whether to overwrite or add the add-on

'overwrite' (default) | 'add'

Whether to overwrite or add the add-on, specified as 'overwrite' or 'add'. By default, installOption is set to 'overwrite'.

If a version of an add-on is already installed:

• If installOption is 'overwrite', then MATLAB overwrites all previously installed versions of the add-on.

• If installOption is 'add', then MATLAB installs the add-on without overwriting previously installed versions.

Output Arguments

newAddon — New add-on information

table

New add-on information, returned as a table with these columns.

Field	Description	Type
Name	Name of the add-on	String scalar
Version	Version of the add-on	String scalar
Enabled	Whether the add-on is enabled	Logical
Identifier	Unique identifier of the add-on	String Scalar

Tips

• Installing an add-on using the matlab -batch command is not supported. To install an add-on from a script, run MATLAB interactively using the matlab -r command instead. For more information, see matlab (Windows), matlab (Linux), or matlab (macOS).

Version History

Introduced in R2018b

R2026b: Not recommended

There are no plans to remove matlab.addons.install. However, mpminstall is recommended over matlab.addons.install for installing add-ons. The mpminstall function provides more flexible options for installing and managing add-ons.

This table shows how to update your code to use mpminstall instead.

Not Recommended	Recommended
installedAddon = matlab.addons.install("C:\Downloads\My toolbox.mltbx")	installedAddon = mpminstall("C:\Downloads\My toolbox.mltbx")
installedAddon = matlab.addons.install("C:\Downloads\My toolbox.mltbx","overwrite")	installedAddon = mpminstall("C:\Downloads\My toolbox.mltbx",AllowVersionReplacement=true)
installedAddon = matlab.addons.install("C:\Downloads\My toolbox.mltbx","add")	installedAddon = mpminstall("C:\Downloads\My toolbox.mltbx",AllowVersionReplacement=false)

R2026b: agreeToLicense argument no longer supported

License agreement occurs by default, and the license agreement and SLA coverage remain in effect, even if the license is not displayed during installation. To view the license agreement for an add-on, go to the Add-Ons panel, and in the Installed section, click the Options button to the right of the add-on. Then, select Open Folder to open the root folder of the add-on in the Files panel.