デプロイ プロジェクト用の TOML プロパティ

R2026b

matlab.toml 定義ファイル タイプを使用すると、プロジェクト全体の構成を 1 つの TOML ファイルで定義して管理できます。この形式は、ソース管理下でのレビューやマージが容易であり、MATLAB® エディターで直接編集できます。詳細については、MATLAB Projects TOML Format (.toml)を参照してください。

ユーザー インターフェイスを使用して Compiler Task を編集すると、プロジェクトはこの情報を matlab.toml ファイルに記録します。次の表に、デプロイ ターゲットごとにプロパティをグループ化した、デプロイ プロジェクトで使用する TOML 構文の例を示します。matlab.toml ファイルで定義されているプロパティの完全なリストについては、matlab.toml を参照してください。

次の TOML コードでは、スタンドアロン アプリケーションとインストーラーを作成するようにコンパイラ タスク StandaloneDesktopApp1 を構成します。

[[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

メモ

ファイルまたはフォルダーのパスを受け入れるプロパティでは、プロジェクト フォルダーからの相対パスまたは絶対パスを使用できます。

[compiler.standalone.build] プロパティ

次の表は、compiler.build.standaloneApplication および compiler.build.standaloneWindowsApplication デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

executable-name

生成されたアプリケーションの名前。名前は英字またはアンダースコアで始まっていなければならず、また英数字とアンダースコアのみ使用できます。

""

custom-help-text-file

アプリケーションのエンド ユーザー向けヘルプ テキストが含まれるヘルプ ファイルへのパス。

""

executable-icon

実行可能ファイルのアイコンとして使用されるアイコン イメージへのパス。使用可能なイメージのタイプは .jpg、.jpeg、.png、.bmp、.gif です。

""

executable-splash-screen

アプリケーションの起動時に表示されるスプラッシュ スクリーン イメージへのパス。使用可能なイメージのタイプは .jpg、.jpeg、.png、.bmp、.gif です。

""

app-file

アプリケーションのメイン ファイルへのパス。

""

additional-files

含める追加のファイルとフォルダー。

[]

runtime-log-file

MATLAB Runtime のログ ファイルの名前。

""

embed-archive

生成される実行可能ファイルにデプロイ可能なアーカイブを組み込むためのフラグ。

true

treat-inputs-as-numeric

コマンド ライン入力を数値の MATLAB double として解釈するためのフラグ。

false

suppress-windows-cmd-prompt

アプリケーションの実行時に Windows® コマンド シェルを表示しないようにするフラグ。

スタンドアロン Windows アプリケーションの場合は true、それ以外の場合は false

executable-version

生成される実行可能ファイルのバージョン。セマンティック バージョニング形式を使用します。

"1.0.0"

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

external-encryption-key

外部暗号化キーを含むファイルへのパス。

""

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

output-folder

出力フォルダーへのパス。

<config name>/build

[compiler.standalone.package] プロパティ

この表は、アプリケーション インストーラーを作成できる compiler.package.installer デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明値

installer-additional-files

アプリケーションとともにインストールする追加のファイルおよびフォルダー。

[]

add-remove-programs-icon

設定内の Windows アプリケーションのリストでアイコンとして使用されるイメージへのパス。

""

application-name

インストールされるアプリケーションの名前。

<build.executable-name>

author-company

アプリケーションを作成した会社の名前。

<project.provider.organization>

author-email

アプリケーション作成者の電子メール アドレス。

<project.provider.email>

author-name

アプリケーション作成者の名前。

<project.provider.name>

default-installation-folder

インストーラーがアプリケーションをインストールする既定のフォルダー。

""

description

アプリケーションの詳細な説明。

<description>

installation-notes

アプリケーションの使用に関する追加要件についてのメモ。

""

installer-icon-file

インストール済みアプリケーションのアイコンとして使用するイメージ ファイルへのパス。

""

installer-logo-file

インストーラーのロゴとして使用するイメージ ファイルへのパス。インストーラーは、ロゴのサイズを 112 x 290 ピクセルに変更します。

""

installer-name

インストーラー ファイルの名前。拡張子はオペレーティング システムによって決まります。

<build.executable-name>Installer

installer-splash-label

インストーラーのスプラッシュ スクリーン イメージのラベルとカテゴリ。

{"category" = <config name>, "label" = "installer splash"}

installer-output-folder

インストーラーが保存されるフォルダーへのパス。

<config name>/package

package-type

インストーラーのファイル タイプ。値には "auto" または "zip" を指定できます。

"auto"

runtime-delivery

MATLAB Runtime の引き渡しオプション。値には "web"、"installer"、または "none" を指定できます。

"web"

shortcut

インストール時にインストーラーがショートカットを作成するファイルまたはフォルダーへのパス。

""

summary

アプリケーションの概要説明。

<summary>

installer-version

インストールされるアプリケーションのバージョン番号。

"1.0.0"

verbose

パッケージ化プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.webApp.build] プロパティ

次の表は、compiler.build.webAppArchive デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

app-file

アプリケーションのメイン ファイルへのパス。

""

additional-files

含める追加のファイルとフォルダー。

[]

archive-name

デプロイ可能なアーカイブの名前。

""

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

external-encryption-key

外部暗号化キーを含むファイルへのパス。

""

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

output-folder

出力フォルダーへのパス。

<config-name>/build

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

autodetect

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.excelAddIn.build] プロパティ

次の表は、compiler.build.excelAddIn デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

add-in-name

Excel アドインの名前。名前は文字で始まり、英字とアンダースコアのみを使用していなければなりません。

""

add-in-version

生成されるアドインのバージョン。

"1.0.0"

additional-files

含める追加のファイルとフォルダー。

[]

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

class-name

クラスの名前。クラス名は、Excel アドインのクラス名の要件を満たしている必要があります。

""

debug-build

デバッグ シンボルを有効にするためのフラグ。

false

embed-archive

デプロイ可能なアーカイブを組み込むためのフラグ。

true

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

generate-visual-basic-file

Visual Basic ファイル (.bas) と Excel アドイン ファイル (.xla) を生成するためのフラグ。

false

runtime-log-file

MATLAB Runtime のログ ファイルの名前。

""

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config-name>/build

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.dotNETAssembly.build] プロパティ

次の表は、compiler.build.dotNETAssembly (MATLAB Compiler SDK) デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

additional-files

含める追加のファイルとフォルダー。

[]

assembly-name

ピリオドで区切られたリストとして指定する、名前空間形式の .NET アセンブリ名。たとえば、companyname.groupname.component です。生成されたライブラリの名前は、ピリオドで区切られたリストの最後のエントリに設定されます。名前は文字で始まり、英字とピリオドのみが含まれる必要があります。

""

assembly-version

アセンブリのバージョン。このプロパティは MWArray API にのみ適用されます。

"1.0.0"

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

class-name

クラスの名前。

""

debug-build

デバッグ シンボルを有効にするためのフラグ。

false

embed-archive

デプロイ可能なアーカイブを組み込むためのフラグ。

true

enable-remoting

アセンブリの .NET リモート処理を有効にするためのフラグ。

false

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

framework-version

ターゲット .NET Framework のバージョン。.NET Framework 4.6.2 以降の任意のバージョンをターゲットにするには、"4.0" と指定します。クロスプラットフォームの .NET 5.0 以降をターゲットにするには、"5.0" と指定します。

"4.0"

interface

アプリケーションとデプロイ済み MATLAB コードとの間のデータ交換を処理するために使用するデータ API。

"matlab-data"

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config name>/build

sample-generation-files

ビルドに含まれる関数用のサンプル ドライバー ファイルを生成する MATLAB サンプル ファイル。ファイルには .m 拡張子が必要です。

[]

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

strong-name-key-file

共有アセンブリに署名する暗号化キー ファイルへのパス。値が空の場合は、プライベート アセンブリが作成されます。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.cSharedLibrary.build] プロパティ

次の表は、compiler.build.cSharedLibrary (MATLAB Compiler SDK) デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

additional-files

含める追加のファイルとフォルダー。

[]

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

debug-build

デバッグ シンボルを有効にするためのフラグ。

false

embed-archive

デプロイ可能なアーカイブを組み込むためのフラグ。

true

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

library-name

共有ライブラリの名前。

""

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config name>/build

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.cppSharedLibrary.build] プロパティ

次の表は、compiler.build.cppSharedLibrary (MATLAB Compiler SDK) デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

additional-files

含める追加のファイルとフォルダー。

[]

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

debug-build

デバッグ シンボルを有効にするためのフラグ。

false

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

interface

アプリケーションとデプロイ済み MATLAB コードとの間のデータ交換を処理するために使用するデータ API。

"matlab-data"

library-name

共有ライブラリの名前。

""

library-version

共有ライブラリのバージョン。セマンティック バージョニング形式を使用します。

"1.0.0"

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config name>/build

sample-generation-files

ビルドに含まれる関数用のサンプル ドライバー ファイルを生成する MATLAB サンプル ファイル。ファイルには .m 拡張子が必要です。

[]

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.comComponent.build] プロパティ

次の表は、compiler.build.comComponent (MATLAB Compiler SDK) デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

additional-files

含める追加のファイルとフォルダー。

[]

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

class-name

クラスの名前。

""

component-name

COM コンポーネントの名前。名前は文字で始まり、英字とピリオドのみが含まれる必要があります。

""

component-version

コンポーネントのバージョン。

"1.0.0"

debug-build

デバッグ シンボルを有効にするためのフラグ。

false

embed-archive

デプロイ可能なアーカイブを組み込むためのフラグ。

true

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config name>/build

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.javaPackage.build] プロパティ

次の表は、compiler.build.javaPackage (MATLAB Compiler SDK) デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

additional-files

含める追加のファイルとフォルダー。

[]

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

class-name

クラスの名前。

""

debug-build

デバッグ シンボルを有効にするためのフラグ。

false

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

interface

アプリケーションとデプロイ済み MATLAB コードとの間のデータ交換を処理するために使用するデータ API。

"matlab-data"

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config name>/build

package-name

ピリオドで区切られたリストとして指定する、名前空間形式のパッケージ名。名前は文字で始まり、英字とピリオドのみが含まれる必要があります。

""

sample-generation-files

ビルドに含まれる関数用のサンプル ドライバー ファイルを生成する MATLAB サンプル ファイル。ファイルには .m 拡張子が必要です。

[]

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

[compiler.pythonPackage.build] プロパティ

次の表は、compiler.build.pythonPackage (MATLAB Compiler SDK) デプロイ ターゲットの TOML プロパティを示しています。

プロパティ説明既定値

function-files

ビルドに含める MATLAB 関数ファイル。

[]

additional-files

含める追加のファイルとフォルダー。

[]

auto-detect-data-files

依存関係の分析によって検出されたデータ ファイルを自動的に含めるかどうかを指定するフラグ。

true

external-encryption-key.key-file

外部の AES 暗号化キー ファイルへのパス。

""

external-encryption-key.runtime-loader-file

実行時に復号化キーを取得する MEX キー ローダー ファイルへのパス。

""

package-name

ピリオドで区切られたリストとして指定する、名前空間形式のパッケージ名。名前は文字で始まり、英字とピリオドのみが含まれる必要があります。

""

sample-generation-files

ビルドに含まれる関数用のサンプル ドライバー ファイルを生成する MATLAB サンプル ファイル。ファイルには .m 拡張子が必要です。

[]

secrets-manifest

デプロイ可能アーカイブに埋め込む秘密鍵を指定する JSON マニフェスト ファイルへのパス。

""

obfuscate-archive

デプロイ可能アーカイブ内のフォルダー構造およびファイル名を難読化するかどうかを指定するフラグ。.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイル内のユーザー コードとデータをユーザー パッケージに格納し、パッケージ化の前に .m ファイルを P ファイルに変換します。JSON ルール ファイルを指定して、ユーザー パッケージに含めるファイルおよびフォルダー、または除外するファイルおよびフォルダーを制御できます。

false

build-output-folder

出力フォルダーへのパス。

<config name>/build

support-packages

含めるサポート パッケージ。値には "autodetect"、"none"、または特定のパッケージ名のリストを指定できます。

"autodetect"

verbose

ビルド プロセス中に進行状況の情報を表示するフラグ。

false

参考

トピック

外部の Web サイト