mpmuninstall

Uninstall package

Since R2024b

Syntax

mpmuninstall(pkg)

mpmuninstall(pkg,Name=Value)

Description

mpmuninstall(pkg) uninstalls the specified package and all of its unused dependencies. A dependency is unused if it was not installed directly and no other packages depend on it. Uninstalled packages are removed from the MATLAB path but package files are not removed from disk by default. Packages that are not successfully uninstalled are not removed from the path.

mpmuninstall(pkg,Name=Value) specifies options using one or more name-value arguments. For example, you can specify whether to uninstall unused package dependencies.

Examples

Uninstall Package

Uninstall the package MyPackage. When prompted, confirm the removal.

mpmuninstall("MyPackage")

The following packages will be uninstalled:
    MyPackage@1.0.0

Do you want to continue? [YES/no]:

Uninstallation complete.

Uninstall Package With Detailed Display Information

Uninstall the package MyPackage and specify detailed display information. When prompted, confirm the removal.

mpmuninstall("MyPackage",Verbosity="detailed")

The following packages will be uninstalled:
    MyPackage@1.0.0

Do you want to continue? [YES/no]:

Successfully removed the following packages from the path:
    MyPackage

Uninstallation complete.

Input Arguments

pkg — MATLAB^® package

string array | matlab.mpm.Package object array | matlab.mpm.PackageSpecifier object array | matlab.mpm.PackageIdentifier object array

MATLAB package, specified as a string array where each element contains a package specifier, matlab.mpm.Package object array, matlab.mpm.PackageSpecifier object array, or matlab.mpm.PackageIdentifierobject array. If packageSpecifier is a string scalar or character vector, then it must contain a package specifier in the format "Name", "Name@VersionRange", or "Name@VersionRange@ID". This option limits the output to only packages whose package specifier fits the specified value.

Example: “packageSource”

Example: “packageSpecifier”

Example: “packageSpecifier@1.0.0”

Example: "Pkg@1.0.1@17487be8-15e8-447b-9319-83516fc31f08"

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: mpmuninstall(pkg,Prompt=true)

Prompt — Display uninstallation prompts

true or 1 (default) | false or 0

Display uninstallation prompts, specified as a numeric or logical 1 (true) or 0 (false). If you specify Prompt as false, then uninstallation prompts are not displayed and the function automatically confirms that packages should be uninstalled when prompted.

Example: Prompt=false

Verbosity — Verbosity level for displayed information

"normal" (default) | "quiet" | "detailed"

Verbosity level for displayed information, specified as one of these values:

• "normal" (default) — Display informational messages during uninstallation.

• "quiet" — Do not display informational messages.

• "detailed" — Display additional informational messages.

Example: Verbosity="quiet"

KeepUnusedDependencies — Keep unused dependencies

false or 0 (default) | true or 1

Keep unused dependencies, specified as a numeric or logical 0 (false) or 1 (true). If you specify KeepUnusedDependencies as true, then the function does not uninstall unused dependencies.

Example: KeepUnusedDependencies=false

Force — Force uninstall

false or 0 (default) | true or 1

Force uninstall, specified as a numeric or logical 0 (false) or 1 (true). If you specify Force as true, then the function uninstalls packages even if another package depends on it.

Example: Force=true

Delete — Delete package files from disk

false or 0 (default) | true or 1

Since R2026a

Delete package files from disk, specified as a numeric or logical 0 (false) or 1 (true). If you specify Delete as true, then the function uninstalls packages and then deletes the package files and folders from disk. If KeepUnusedDependencies is false, dependencies of removed packages are uninstalled and deleted from disk as well. Regardless of the value of Delete, packages that are installed in-place are uninstalled but are not deleted from disk.

Example: Delete=true

Version History

Introduced in R2024b

R2026a: Delete uninstalled packages from disk

Use the Delete name-value argument for mpmuninstall to uninstall packages and their dependencies and then delete the corresponding package files and folders from disk. For example, uninstall the astronomy package and delete its files and folders.

mpmuninstall("astronomy",Delete=true)

The following packages will be uninstalled:
    astronomy@3.0.0
        astrophysics@1.0.0
        LinearAlgebra@1.0.0

The following package roots will be deleted
    astronomy@3.0.0 (C:\Users\jdoe\AppData\Roaming\MathWorks\MATLAB Add-Ons\astronomy@3.0.0)
    astrophysics@1.0.0 (C:\Users\jdoe\AppData\Roaming\MathWorks\MATLAB Add-Ons\astrophysics@1.0.0)
    LinearAlgebra@1.0.0 (C:\Users\jdoe\AppData\Roaming\MathWorks\MATLAB Add-Ons\LinearAlgebra@1.0.0)

Do you want to continue? [YES/no]:

Deleting folder 'C:\Users\jdoe\AppData\Roaming\MathWorks\MATLAB Add-Ons\astronomy@3.0.0'...Done.
Deleting folder 'C:\Users\jdoe\AppData\Roaming\MathWorks\MATLAB Add-Ons\astrophysics@1.0.0'...Done.
Deleting folder 'C:\Users\jdoe\AppData\Roaming\MathWorks\MATLAB Add-Ons\LinearAlgebra@1.0.0'...Done.

Uninstallation complete.

Packages that are installed in-place are uninstalled but not deleted and must be removed from disk manually.

R2026a: Uninstalling a package that is a dependency now errors

Attempting to uninstall an installed package that is a dependency of another package now errors.

Previously, if a package that was installed as a standalone package was also a dependency of another installed package, then calling mpmuninstall on that package did not uninstall the package but did change the DirectlyInstalled property to false (or, the old InstalledAsDependency property to true).