Export Package Commands

Last modified: August 20, 2024

Introduction

The commands in this group enable exporting different kids of packages from your app.

mx create-project-package Command

The mx create-project-package command exports the app as a source app package.

Usage

Use the following command pattern:

mx create-project-package [OPTIONS] TARGET-FILE

These are the OPTIONS:

Option Result
-s, --include-snapshot Includes a snapshot in the app package.
-d, --package-dir Exports the package to the directory.
--help Displays the help screen.

For TARGET-FILE, specify the .mpr app you want to export.

Examples

Here is an example:

mx create-project-package c:\MyApps\MyApp.mpr

Return Codes

This table shows the return codes and their description:

Return Code Description
0 OK.
1 Incorrect app file provided.
2 Output folder not determined.
4 Unknown package export error.

mx create-module-package Command

The mx create-module-package command exports a module package from an app.

Usage

Use the following command pattern:

mx create-module-package [OPTIONS] TARGET-FILE MODULE-NAME

These are the OPTIONS:

Option Description
-l, --filter-required-libs Includes all the files except the userlibs that do not have an accompanying [ModuleName].RequiredLib file.
-e, --exclude-files Excludes all the files that match the given regular expression.
-d, --package-dir Exports the module package to the directory.
--help Displays the help screen.

For TARGET-FILE, specify the .mpr app you want to export.

For MODULE-NAME, specify the name of the module you want to export.

Examples

Here is an example:

mx create-module-package c:\MyApps\MyApp.mpr Module1

Return Codes

This table shows the return codes and their description:

Return Code Description
0 OK.
1 Incorrect app file provided.
2 Output folder not determined.
3 Invalid module name specified.
4 Unknown package export error.

mx create-solution-package Command

The mx create-solution-package command exports the app as a solution package.

Usage

Use the following command pattern:

mx create-solution-package [OPTIONS] TARGET-FILE

These are the OPTIONS:

Option Result
-s, --include-snapshot Includes a snapshot in the app package.
-d, --package-dir Exports the package to the directory.
--help Displays the help screen.

For TARGET-FILE, specify the .mpr app you want to export.

Examples

Here is an example:

mx create-solution-package c:\MyApps\MyApp.mpr

Return Codes

This table shows the return codes and their description:

Return Code Description
0 OK.
1 Incorrect app file provided.
2 Output folder not determined.
4 Unknown package export error.