TOML Properties for Deployment Projects

R2026b

The matlab.toml definition file type allows you to define and manage your entire project configuration in a single TOML file. This format is easier to review and merge under source control, and you can edit it directly in the MATLAB^® editor. For more information, see MATLAB Projects TOML Format (.toml).

When you edit a Compiler Task using the user interface, the project logs this information to the matlab.toml file. The following tables provide examples of the TOML syntax used in deployment projects, where properties are grouped by deployment target. For the full list of properties defined in the matlab.toml file, see matlab.toml.

The following TOML code configures the compiler task StandaloneDesktopApp1 to create a standalone application and installer.

Example matlab.toml

[[compiler.standalone]]
configuration-name = "StandaloneDesktopApp1"
[compiler.standalone.build]
executable-name = ""
custom-help-text-file = "" 
executable-icon = "" 
executable-splash-screen = "" 
app-file = "" 
additional-files = [] 
runtime-log-file = ""
embed-archive = true
treat-inputs-as-numeric = false
suppress-windows-cmd-prompt = true
executable-version = "1.0.0" 
auto-detect-data-files = true
external-encryption-key = ""
obfuscate-archive = false
secrets-manifest = ""
support-packages = "autodetect" # autodetect, none, or [package1, package2]
verbose = false
output-folder = "<config-name>/build"

[compiler.standalone.package]
#Win only
add-remove-programs-icon = "" 

application-name = "<build.executable-name>"
author-company = "<project.provider.organization>"
author-email = "<project.provider.email>"
author-name = "<project.provider.name>"

default-installation-folder = "" # Generic install location

description = "<description>"
installation-notes = ""
installer-additional-files = [] 
installer-icon = "" 
installer-logo = "" 
installer-name = "<build.executable-name>Installer"

#Warns on Linux
installer-splash = "" 

installer-output-folder = "<config-name>/package"
package-type = "auto" # auto or zip (zip is win only)
runtime-delivery = "web" # web, installer, or none

#Win only
shortcut = ""

summary = "<summary>"
installer-version = "1.0.0" # semver 
verbose = false

Note

Properties that accept file or folder paths support paths relative to the project folder or absolute paths.

[compiler.standalone.build] Properties

This table shows the TOML properties for the compiler.build.standaloneApplication and compiler.build.standaloneWindowsApplication deployment targets.

Property	Description	Default value
executable-name	Name of the generated application. Names must begin with a letter or underscore character and contain only alphanumeric characters or underscores.	""
custom-help-text-file	Path to a help file containing help text for the end user of the application.	""
executable-icon	Path to the icon image that serves as the icon for the executable. Accepted image types are .jpg, .jpeg, .png, .bmp, and .gif.	""
executable-splash-screen	Path to the splash screen image displayed when the application starts. Accepted image types are .jpg, .jpeg, .png, .bmp, and .gif.	""
app-file	Path to the main file of the application.	""
additional-files	Additional files and folders to include.	[]
runtime-log-file	Name of the log file for MATLAB Runtime.	""
embed-archive	Flag to embed the deployable archive in the generated executable.	true
treat-inputs-as-numeric	Flag to interpret command line inputs as numeric MATLAB doubles.	false
suppress-windows-cmd-prompt	Flag to suppress the Windows® command shell when running the application.	True for standalone Windows applications; false otherwise
executable-version	Version of the generated executable. Uses semantic versioning format.	"1.0.0"
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
external-encryption-key	Path to a file containing an external encryption key.	""
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false
output-folder	Path to the output folder.	<config name>/build

[compiler.standalone.package] Properties

This table shows the TOML properties for the compiler.package.installer deployment target, which lets you create application installers.

Property	Description	Value
installer-additional-files	Additional files and folders to install with the application.	[]
add-remove-programs-icon	Path to an image that serves as the icon in the list of Windows applications in settings.	""
application-name	Name of the installed application.	<build.executable-name>
author-company	Name of the company that created the application.	<project.provider.organization>
author-email	Email address of the application author.	<project.provider.email>
author-name	Name of the application author.	<project.provider.name>
default-installation-folder	Default folder where the installer installs the application.	""
description	Detailed description of the application.	<description>
installation-notes	Notes about additional requirements for using the application.	""
installer-icon-file	Path to an image file used as the icon for the installed application.	""
installer-logo-file	Path to an image file used as the installer logo. The installer resizes the logo to 112-by-290 pixels.	""
installer-name	Name of the installer file. The extension is determined by the operating system.	<build.executable-name>Installer
installer-splash-label	Label and category for the installer splash screen image.	{"category" = <config name>, "label" = "installer splash"}
installer-output-folder	Path to the folder where the installer is saved.	<config name>/package
package-type	Installer file type. Value can be "auto" or "zip".	"auto"
runtime-delivery	MATLAB Runtime delivery option. Value can be "web", "installer", or "none".	"web"
shortcut	Path to a file or folder for which the installer creates a shortcut at install time.	""
summary	Summary description of the application.	<summary>
installer-version	Version number of the installed application.	"1.0.0"
verbose	Flag to display progress information during the packaging process.	false

[compiler.webApp.build] Properties

This table shows the TOML properties for the compiler.build.webAppArchive deployment target.

Property	Description	Default value
app-file	Path to the main file of the application.	""
additional-files	Additional files and folders to include.	[]
archive-name	Name of the deployable archive.	""
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
external-encryption-key	Path to a file containing an external encryption key.	""
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
output-folder	Path to the output folder.	<config-name>/build
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	autodetect
verbose	Flag to display progress information during the build process.	false

[compiler.excelAddIn.build] Properties

This table shows the TOML properties for the compiler.build.excelAddIn deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
add-in-name	Name of the Excel add-in. The name must begin with a letter and contain only alphabetic characters and underscores.	""
add-in-version	Version of the generated add-in.	"1.0.0"
additional-files	Additional files and folders to include.	[]
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
class-name	Name of the class. Class names must meet Excel add-in class name requirements.	""
debug-build	Flag to enable debug symbols.	false
embed-archive	Flag to embed the deployable archive.	true
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at run time.	""
generate-visual-basic-file	Flag to generate a Visual Basic file (.bas) and an Excel add-in file (.xla).	false
runtime-log-file	Name of the log file for MATLAB Runtime.	""
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config-name>/build
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false

[compiler.dotNETAssembly.build] Properties

This table shows the TOML properties for the compiler.build.dotNETAssembly (MATLAB Compiler SDK) deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
additional-files	Additional files and folders to include.	[]
assembly-name	Name of the .NET assembly as a namespace, which is a period-separated list, for example, companyname.groupname.component. The name of the generated library is set to the last entry of the period-separated list. The name must begin with a letter and contain only alphabetic characters and periods.	""
assembly-version	Assembly version. This property applies only to the MWArray API.	"1.0.0"
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
class-name	Name of the class.	""
debug-build	Flag to enable debug symbols.	false
embed-archive	Flag to embed the deployable archive.	true
enable-remoting	Flag to enable .NET remoting for the assembly.	false
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at runtime.	""
framework-version	Target .NET framework version. Specify "4.0" to target any version of the .NET Framework from 4.6.2 upwards. To target the cross-platform .NET 5.0 or later, specify "5.0".	"4.0"
interface	Data API used for handling data exchange between the application and deployed MATLAB code.	"matlab-data"
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config name>/build
sample-generation-files	MATLAB sample files that generate sample driver files for functions included in the build. Files must have a .m extension.	[]
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
strong-name-key-file	Path to the encryption key file that signs the shared assembly. If the value is empty, a private assembly is created.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false

[compiler.cSharedLibrary.build] Properties

This table shows the TOML properties for the compiler.build.cSharedLibrary (MATLAB Compiler SDK) deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
additional-files	Additional files and folders to include.	[]
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
debug-build	Flag to enable debug symbols.	false
embed-archive	Flag to embed the deployable archive.	true
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at runtime.	""
library-name	Name of the shared library.	""
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config name>/build
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false

[compiler.cppSharedLibrary.build] Properties

This table shows the TOML properties for the compiler.build.cppSharedLibrary (MATLAB Compiler SDK) deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
additional-files	Additional files and folders to include.	[]
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
debug-build	Flag to enable debug symbols.	false
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at runtime.	""
interface	Data API used for handling data exchange between the application and deployed MATLAB code.	"matlab-data"
library-name	Name of the shared library.	""
library-version	Version of the shared library. Uses semantic versioning format.	"1.0.0"
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config name>/build
sample-generation-files	MATLAB sample files that generate sample driver files for functions included in the build. Files must have a .m extension.	[]
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false

[compiler.comComponent.build] Properties

This table shows the TOML properties for the compiler.build.comComponent (MATLAB Compiler SDK) deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
additional-files	Additional files and folders to include.	[]
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
class-name	Name of the class.	""
component-name	Name of the COM component. The name must begin with a letter and contain only alphabetic characters and periods.	""
component-version	Component version.	"1.0.0"
debug-build	Flag to enable debug symbols.	false
embed-archive	Flag to embed the deployable archive.	true
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at runtime.	""
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config name>/build
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false

[compiler.javaPackage.build] Properties

This table shows the TOML properties for the compiler.build.javaPackage (MATLAB Compiler SDK) deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
additional-files	Additional files and folders to include.	[]
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
class-name	Name of the class.	""
debug-build	Flag to enable debug symbols.	false
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at runtime.	""
interface	Data API used for handling data exchange between the application and deployed MATLAB code.	"matlab-data"
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config name>/build
package-name	Name of the package as a namespace, which is a period-separated list. The name must begin with a letter and contain only alphabetic characters and periods.	""
sample-generation-files	MATLAB sample files that generate sample driver files for functions included in the build. Files must have a .m extension.	[]
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false

[compiler.pythonPackage.build] Properties

This table shows the TOML properties for the compiler.build.pythonPackage (MATLAB Compiler SDK) deployment target.

Property	Description	Default value
function-files	MATLAB function files to include in the build.	[]
additional-files	Additional files and folders to include.	[]
auto-detect-data-files	Flag to automatically include data files discovered by dependency analysis.	true
external-encryption-key.key-file	Path to the external AES encryption key file.	""
external-encryption-key.runtime-loader-file	Path to the MEX key loader file that retrieves the decryption key at runtime.	""
package-name	Name of the package as a namespace, which is a period-separated list. The name must begin with a letter and contain only alphabetic characters and periods.	""
sample-generation-files	MATLAB sample files that generate sample driver files for functions included in the build. Files must have a .m extension.	[]
secrets-manifest	Path to a JSON manifest file specifying secret keys to embed in the deployable archive.	""
obfuscate-archive	Flag to obfuscate folder structures and file names in the deployable archive, place user code and data in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files into a user package, and convert .m files to P-files before packaging. Specify a JSON rule file to control which files and folders are included in or excluded from the user package.	false
build-output-folder	Path to the output folder.	<config name>/build
support-packages	Support packages to include. Value can be "autodetect", "none", or a list of specific package names.	"autodetect"
verbose	Flag to display progress information during the build process.	false