Addon/Toolbox Post Install Hooks

I was wondering if there is any form of post install hooks for add-ons and downloads. Depending on the environment an installation happens in there may be a need to apply some post install configuration. I couldn't find anything in the docs or Package Toolbox dialog. Was hoping somebody else has found a solution that I may not have found in the docs.

Install toolbox file - MATLAB matlab.addons.toolbox.installToolbox (mathworks.com)

Install add-on - MATLAB matlab.addons.install (mathworks.com)

The ideal solution would be one that works in interactive (GUI, Command Window) and non interactive environments (CI, deployments, scripts etc).

Answer 1

[Jack]

Yes, there is a way to run post-installation code after installing a MATLAB add-on or toolbox using the MATLAB Add-On Manager.

You can create a file named "startup.m" in your MATLAB user folder or project folder. MATLAB automatically runs this file when it starts up, and you can use it to run any custom code you want.

To run post-installation code after installing an add-on or toolbox, you can add the code to the "startup.m" file, and MATLAB will run it the next time it starts up. You can use conditional statements to make sure that the post-installation code only runs if the add-on or toolbox has been installed.

For example, you can use the "isToolboxInstalled" function to check if a specific toolbox is installed, and then run the post-installation code if it is. Here's an example:

if isToolboxInstalled('myToolbox')
    % Run post-installation code here
end

Similarly, you can use the "isAddonEnabled" function to check if a specific add-on is enabled, and then run the post-installation code if it is. Here's an example:

if isAddonEnabled('myAddon')
    % Run post-installation code here
end

You can also use other functions and commands in the "startup.m" file to configure your MATLAB environment or load specific settings and preferences.

Note that the "startup.m" file is run every time MATLAB starts up, so make sure your code is efficient and doesn't cause unnecessary delays or errors.

[Alexander]

Thanks Jack, I should clarify this is a post install script that is part of the addon/toolbox, not a user driven interaction. Since installing an mltbx/addon is driven by the API or IDE I'm wondering if there is a way for my toolbox/addon to have a custom stage in that install or post install.

[Jack]

Ah, I see. In that case, you can add a custom install script to your MATLAB toolbox/add-on to perform any necessary post-installation steps. Here are the steps to do so:

1. Create a script file that contains the post-installation steps you want to perform. Make sure the script is compatible with the version of MATLAB you are targeting.
2. In the root directory of your MATLAB toolbox/add-on, create a folder called "resources" if it doesn't exist already.
3. Inside the "resources" folder, create a new folder called "scripts".
4. Save your post-installation script file in the "scripts" folder.
5. Rename your script file to "postInstall.m". This is the standard name for a post-installation script in MATLAB.
6. In your toolbox/add-on installation script, add the following command to run the post-installation script:

install.addon({'toolbox_name'},'postinstall','true');

Replace "toolbox_name" with the name of your toolbox/add-on. This command will trigger the post-installation script after the toolbox/add-on is installed.

1. Make sure your toolbox/add-on and the post-installation script have appropriate permissions to run on the target machine.

That should do it! When a user installs your toolbox/add-on, MATLAB will automatically run the post-installation script after installation is complete. You can use this script to perform any necessary setup, configuration, or other tasks that your toolbox/add-on requires.

[Alexander]

Thanks Jack, can you link to the docs for this? If I run help install I get --- install not found. Showing help for istall instead. ---. Same for matlab.install. I can't find anything in the add on install doc describing the functionality you mention.

[Jack]

I apologize for the confusion. The install function I mentioned is actually part of the MATLAB Add-On Explorer and is used to install add-ons from the MATLAB Central File Exchange or other repositories.

To install support packages in MATLAB, you can use the "Add-Ons" menu in the MATLAB desktop interface:

1. Click on the "Add-Ons" dropdown menu in the MATLAB desktop interface.
2. Select "Get Add-Ons" to open the Add-On Explorer.
3. In the "Available Add-Ons" tab, search for the support package you want to install.
4. Click on the support package to open its details page.
5. Click the "Install" button to download and install the support package.

Alternatively, you can use the supportPackageInstaller function to install support packages programmatically from the command line. Here's an example code snippet:

supportPackageInstaller % open the support package installer GUI

This code should open the support package installer, where you can select and install the support package you need.

I hope this helps! Let me know if you have any further questions.

[Alexander]

No problem, thanks for explaining that. I updated my original question since an ideal packaging solution works for interactive and non interactive environments. I did want to mention it looks like supportPackageInstaller is actively discouraged by Mathworks in the docs.

Install support for third-party hardware or software (Not recommended) - MATLAB supportPackageInstaller (mathworks.com)

Do you know of an install api method available from the command window that also handles post install scripts, or only the GUI AddOn view?

Appreciate your help and all the information.