diff --git a/content/en/docs/refguide/general/mx-command-line-tool/_index.md b/content/en/docs/refguide/general/mx-command-line-tool/_index.md index 60712f1c6f5..5b6f5447d70 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/_index.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/_index.md @@ -28,7 +28,7 @@ These are the available [app commands](/refguide/mx-command-line-tool/app/): | [check](/refguide/mx-command-line-tool/app/#check) | Checks the app for issues. | | [convert](/refguide/mx-command-line-tool/app/#convert) | Converts the Mendix app. | | [create-project](/refguide/mx-command-line-tool/app/#create-project) | Creates a new Mendix app. | -| [show-version](/refguide/mx-command-line-tool/app/#show-version) | Shows the Studio Pro version that was last used to edit the app. | +| [show-version](/refguide/mx-command-line-tool/app/#show-version) | Shows the Studio Pro version used to last edit the app. | | [show-java-version](/refguide/mx-command-line-tool/app/#show-java-version) | Shows the configured Java version of the app. | | [sync-java-dependencies](/refguide/mx-command-line-tool/app/#java-dependencies) | Synchronizes the managed Java dependencies that are configured in the modules of the app. | | [translate](/refguide/mx-command-line-tool/app/#translate) | Exports and imports all translatable texts included in your application. | @@ -51,7 +51,7 @@ These are the available [module commands](/refguide/mx-command-line-tool/module/ |---|---| | [show-module-version](/refguide/mx-command-line-tool/module/#show-module-version) | Shows the version of a module. | | [set-module-version](/refguide/mx-command-line-tool/module/#set-module-version) | Sets the version of a module. | -| [module-import](/refguide/mx-command-line-tool/module/#module-import) | Import a module from an mpk package into an app. | +| [module-import](/refguide/mx-command-line-tool/module/#module-import) | Imports a module from an mpk package into an app. | ### Export Package Commands @@ -71,7 +71,7 @@ These are the available [merging and diffing commands](/refguide/mx-command-line | --- | --- | | [merge](/refguide/mx-command-line-tool/merge/#merge) | Merges the *.mpr* files. | | [diff](/refguide/mx-command-line-tool/merge/#diff) | Shows the diff of the *.mpr* files. | -| [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Create a JSON description of the model of a Mendix app. | +| [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Creates a JSON description of the model of a Mendix app. | ### Private Values Commands @@ -84,7 +84,7 @@ These are the available [private values commands](/refguide/mx-command-line-tool ### Security Overview Command -The available `export-security-overview` exports the [Security Overview](/refguide/security-overview/). For more information, see [Security Overview Command](/refguide/mx-command-line-tool/security/#export-security-overview). +The `export-security-overview` command exports the [Security Overview](/refguide/security-overview/). For more information, see [Security Overview Command](/refguide/mx-command-line-tool/security/#export-security-overview). ## Undocumented Options diff --git a/content/en/docs/refguide/general/mx-command-line-tool/adaptable.md b/content/en/docs/refguide/general/mx-command-line-tool/adaptable.md index 32693beb123..e1f01fa88e0 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/adaptable.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/adaptable.md @@ -1,37 +1,37 @@ --- title: "Adaptable Solution Commands" -url: /refguide/mx-command-line-tool/adaptable +url: /refguide/mx-command-line-tool/adaptable/ weight: 20 -description: "Describes the adaptable solution-related commands for the mx command-line tool." +description: "Describes commands for managing adaptable solution versions in the mx command-line tool." --- ## Introduction The commands in this group are related to [adaptable solutions](/appstore/creating-content/sol-adapt/). -These commands use common format exit codes. +These commands use a common exit code format. -The commands return `0` in case of success. +The commands return `0` on success. -In case of errors, the exit code consists of three digits `XYZ`: +On error, the exit code consists of three digits `XYZ`: -* `X` determines the error type: +* `X` – Error type: * `1` – parameter validation error * `2` – output-related error - * `3` – errors related to the execution of the operation -* `Y` is the number of the parameter the error is related to (if applicable). If the error is not related to the parameters, this is zero. -* `Z` determines error details: - * `1` – file is not found + * `3` – operation execution error +* `Y` – Parameter number the error relates to (if applicable). This is zero if the error is not parameter-related. +* `Z` – Error detail: + * `1` – file not found * `2` – app is too old * `3` – distribution is not enabled - * `4` – version is not in the SemVer format + * `4` – version is not in SemVer format * `5` – app was not initialized from a solution package For exit code examples, refer to the specific commands below. ## mx show-app-version Command {#show-app-version} -The `mx show-app-version` command enables seeing the [publisher-side](/appstore/creating-content/sol-solutions-guide/) version of your solution (the version of the solution that you develop) and the [consumer-side](/appstore/creating-content/sol-solutions-impl/) version of the solution package that your app is based on (the version of the solution package when you consumed the solution). +The `mx show-app-version` command shows the [publisher-side](/appstore/creating-content/sol-solutions-guide/) version of your solution (the version you develop) and the [consumer-side](/appstore/creating-content/sol-solutions-impl/) version of the solution package your app is based on (the version when you consumed the solution). ### Usage @@ -41,14 +41,14 @@ Use the following command pattern for `mx show-app-version`: These are the `OPTIONS`: -| Option | Shortcut | Result | +| Option | Shortcut | Description | | --- | --- | --- | | `--based-on` | `-b` | Shows the `Based on` version. | | `--help` | | Shows help for the `mx show-app-version` command and exits. | For `MPR-FILE`, enter an *.mpr* file. -The `--based-on` version is a version of a solution package (*.mxsolution*) that the current app is based on. +The `--based-on` version is the version of the solution package (*.mxsolution*) that the current app is based on. ### Examples @@ -59,19 +59,19 @@ Here are two examples: ### Return Codes -This command uses the common format exit codes described above for all app-version related commands. +This command uses the common exit code format described above for all app-version related commands. -This table shows the return codes and their description: +This table shows the return codes and their descriptions: | Return Code | Description | | --- | --- | | `0` | No errors. | -| `315` | If `-b` was specified, but the app is not based on a solution. | -| `313` | If `-b` was not specified, but distribution as a solution is not enabled for the app. | +| `315` | The `-b` flag was specified, but the app is not based on a solution. | +| `313` | The `-b` flag was not specified, but distribution as a solution is not enabled for the app. | ## mx set-app-version Command {#set-app-version} -The `mx set-app-version` command enables setting the version of your [solution](/appstore/creating-content/sol-solutions-guide/) when building it. +The `mx set-app-version` command sets the version of your [solution](/appstore/creating-content/sol-solutions-guide/) when building it. ### Usage @@ -81,7 +81,7 @@ Use the following command pattern for `mx set-app-version`: These are the `OPTIONS`: -| Option | Result | +| Option | Description | | --- | --- | | `--help` | Shows help for the `mx set-app-version` command and exits. | @@ -97,12 +97,12 @@ Here is an example: ### Return Codes -This command uses the common format exit codes described above for all app-version related commands. +This command uses the common exit code format described above all app-version related commands. -This table shows the return codes and their description: +This table shows the return codes and their descriptions: | Return Code | Description | | --- | --- | | `0` | No errors. | -| `124` | The version is not in the SemVer format. | +| `124` | The version is not in SemVer format. | | `313` | Distribution as a solution is not enabled for the app. | diff --git a/content/en/docs/refguide/general/mx-command-line-tool/analyze-mpr.md b/content/en/docs/refguide/general/mx-command-line-tool/analyze-mpr.md index c7d602772bf..e18e12900b0 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/analyze-mpr.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/analyze-mpr.md @@ -2,45 +2,45 @@ title: "MPR Analyze Command" url: /refguide/mx-command-line-tool/analyze-mpr/ weight: 60 -description: "Describes MPR analyze command, which shows the contents of the MPR file and their contribution to file size." +description: "Describes the MPR analyze command, which shows the contents of the MPR file and their contribution to file size." --- ## Introduction -The `mx analyze-mpr` command enables you to show information about the MPR file in the form of plaintext. +The `mx analyze-mpr` command shows information about the MPR file in plaintext format. {{% alert color="warning" %}} -We do not recommend building custom tooling on top of this outpur, as the output and the format may change over time. +Mendix does not recommend building custom tooling on top of this output, as the output and format may change over time. {{% /alert %}} ## Usage Use the following command pattern: `mx analyze-mpr TARGET-FILE [OPTIONS]` -The `TARGET-FILE` points to the location of the project file (this file has the extension *.mpr*). +The `TARGET-FILE` points to the location of the project file with the *.mpr* extension. The `OPTIONS` are described in the table below: | Option | Result | | --- | --- | -| `--big-string-threshold` | (Default: 1000) The number of bytes from which to consider a String value 'big' (for `Content categories` section) | -| `--big-blob-threshold` | (Default: 1000) The number of bytes from which to consider a BLOB value 'big' (for `Content categories` section) | -| `--help` | Displays the help screen. | +| `--big-string-threshold` | The number of bytes from which to consider a String value `big` (for the `Content categories` section). Default: *1000* | +| `--big-blob-threshold` | The number of bytes from which to consider a BLOB value `big` (for the `Content categories` section). Default: *1000* | +| `--help` | Displays the help screen | ### Analysis -To identify which types of documents (pages, microflows, etc.) have the largest contribution to the MPR file size, you can focus on the **Size by unit type** section, where the number of occurrences and file size contribution are displayed in percentage. +To identify which types of documents (pages, microflows, etc.) contribute most to the MPR file size, focus on the **Size by unit type** section. This section displays the number of occurrences and file size contribution as a percentage. -You can use the MPR Tool to get more details. You can find it at *C:\Program Files\Mendix\\modeler\MprTool.exe* (where should be replaced with your installed Mendix version). After opening the *.mpr* file for your app, use **Search** > **Find unit by ID** to find the name and module for a particular unit. +To get more details, use the MPR Tool located at *C:\Program Files\Mendix\\modeler\MprTool.exe* (replace with your installed Mendix version). After opening the *.mpr* file for your app, use **Search** > **Find unit by ID** to find the name and module for a unit. ### Examples -Valid examples are given below: +The following examples show valid usage: * `mx analyze-mpr temp.mpr` -* `mx analyze-mpr temp.mpr > analysis.txt`, to output to a text file +* `mx analyze-mpr temp.mpr > analysis.txt` to output to a text file -An example of the output is presented below: +The following example shows the command output:
Expand for code sample diff --git a/content/en/docs/refguide/general/mx-command-line-tool/app.md b/content/en/docs/refguide/general/mx-command-line-tool/app.md index a768e375371..170d845b7f3 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/app.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/app.md @@ -1,19 +1,19 @@ --- title: "App Commands" -url: /refguide/mx-command-line-tool/app +url: /refguide/mx-command-line-tool/app/ weight: 10 description: "Describes the app-related commands for the mx command-line tool." --- ## Introduction -The commands in this group are related to Mendix app creation, checking, versioning, and conversion. +The commands in this group are related to Mendix app creation, checking, versioning, and conversion tasks. -Typically, these commands require a path to the *.mpr* file as a parameter. +Most commands require a path to the *.mpr* file as a parameter. ## mx create-project Command {#create-project} -The `mx create-project` command creates a new app in Studio Pro. The app version depends on the version the tool was bundled with. For example, if you are using the mx tool for Studio Pro 11.0.0, `mx create project` will create a new app in that version. +The `mx create-project` command creates a new app in Studio Pro. The app version depends on the version the tool was bundled with. For example, if you are using the mx tool for Studio Pro 11.0.0, `mx create project` will create a new app in that version. ### Usage @@ -26,11 +26,11 @@ These are the `OPTIONS`: | `--app-name` | App | Assigns the specified app name to the app. | | `--help` | | Shows help for the `mx create-project` command and exits. | | `--language-code` | en_US | The default language of the app. | -| `--use-mpr-format-v1` | MPRv2 | If specified, the app is created in MPRv1 format (otherwise, with MPRv2). | +| `--use-mpr-format-v1` | MPRv2 | If specified, the app is created in MPRv1 format (otherwise, with MPRv2). | | `--output-dir` | Current directory | The directory in which to create the app. | -| `--sprintr-app-id` | Optional | Associates the app [feedback features](/developerportal/app-insights/feedback/) with the provided [app](/developerportal/#my-apps) in **Apps**. The value is a GUID. When accessing the app in [Apps](https://sprintr.home.mendix.com/), this ID can be found in the browser's URL (for example, `1a428ea7-b00e-4166-9b23-20b7be88a40e`). | +| `--sprintr-app-id` | Optional | Associates the app [feedback features](/developerportal/app-insights/feedback/) with the provided [app](/developerportal/#my-apps) in **Apps**. The value is a GUID. You can find this ID in the browser URL when you access the app in [Apps](https://sprintr.home.mendix.com/) (for example, `1a428ea7-b00e-4166-9b23-20b7be88a40e`). | -`TEMPLATE-MPK-FILE` is an optional path to a Mendix app package *.mpk* file. If this argument is omitted, the app is created with a default empty project template. +`TEMPLATE-MPK-FILE` is an optional path to a Mendix app package *.mpk* file. If omitted, the command creates the app with a default empty project template. ### Examples @@ -54,7 +54,7 @@ These are the return codes: ## mx show-version Command {#show-version} -The `mx show-version` command reports which version of Studio Pro was used last time the app was opened. +The `mx show-version` command reports which version of Studio Pro last opened the app. The input is a single *.mpr* file. @@ -93,14 +93,14 @@ These are the return codes: | --- | --- | | `0` | The command ran successfully. | -## mx show-java-version Command{#show-java-version} +## mx show-java-version Command {#show-java-version} -{The `mx show-java-version` command reports what the configured Java version of the app is. +The `mx show-java-version` command reports the configured Java version of the app. -The input is a single MPR file. +The input is a single *.mpr* file. {{% alert color="info" %}} -The MPR file must be the same version as mx. +The *.mpr* file must be the same version as the mx tool. {{% /alert %}} ### Usage @@ -113,7 +113,7 @@ For `INPUT`, enter an *.mpr* file. ### Examples -Examples of commands are described in the table below: +These are example commands: | Example | Result | | --- | --- | @@ -121,16 +121,16 @@ Examples of commands are described in the table below: ### Return Codes -Return codes are described in the table below: +These are the return codes: | Return Code | Description | | --- | --- | -| 0 | The command ran successfully. | -| 1 | The command failed. For example because the *.mpr* file could not be found. | +| `0` | The command ran successfully. | +| `1` | The command failed, for example, because the *.mpr* file could not be found. | ## mx convert Command {#convert} -The `mx convert` command converts the *.mpk* file (or files) of the app (or apps) to a specific Studio Pro version. For example, if you are using the mx command-line tool for Studio Pro 11.0.0, `mx convert` will convert the app to that version. +The `mx convert` command converts app *.mpk* file (or files) of the app (or apps) to a specific Studio Pro version. For example, the mx command-line tool for Studio Pro 11.0.0 converts apps to version 11.0.0. The input can be a single file, directory, or multiple files. @@ -148,16 +148,16 @@ These are the `OPTIONS`: | Option | Shortcut | Result | | --- | --- | --- | -| `--help` | | Shows help for the `mx convert`` command and exits. | -| `--in-place` | `-p` | Converts the current app directory. Use this option to convert a folder containing a Mendix app. Otherwise, `mx convert` will convert *.mpk* files. | -| `--skip-error-check` | `-s` | Does not check for errors. Use this option to disable app error-checking during the conversion. When omitted, the tool will report on the number of errors, warnings, and deprecations in the app and do the conversion. | +| `--help` | | Shows help for the `mx convert` command and exits. | +| `--in-place` | `-p` | Converts the current app directory. Use this option to convert a folder containing a Mendix app. Otherwise, `mx convert` converts *.mpk* files. | +| `--skip-error-check` | `-s` | Does not check for errors. Use this option to disable app error checking during conversion. When omitted, the tool reports the number of errors, warnings, and deprecations in the app before converting it. | For `INPUT...`, enter one or more *.mpk* files or one directory that needs to be converted. -For `OUTPUT`, enter the output location for the converted results. Please note the following: +For `OUTPUT`, enter the output location for the converted results. Note the following: -* When `INPUT...` is a single file, `OUTPUT` can be a single file or directory; otherwise, `OUTPUT` must be a directory -* When using the `--in-place` option, the `INPUT...` folder will also be used as the `OUTPUT` folder, so you do not need to specify a separate `OUTPUT` folder +* When `INPUT...` is a single file, `OUTPUT` can be a single file or directory. Otherwise, `OUTPUT` must be a directory. +* When using the `--in-place` option, the `INPUT...` folder is also used as the `OUTPUT` folder, so you do not need to specify a separate `OUTPUT` folder. ### Examples @@ -165,7 +165,7 @@ These are example commands: | Example | Result | | --- | --- | -| `mx convert --in-place C:\MxProjects\App-main` | Converts the app in folder *C:\MxProjects\App-main* to the specific Studio Pro version that the mx tool is bundled with. | +| `mx convert --in-place C:\MxProjects\App-main` | Converts the app in folder *C:\MxProjects\App-main* to the Studio Pro version that the mx tool is bundled with. | | `mx convert C:\Mendix\App1.mpk C:\Mendix\App2.mpk C:\Mendix\ConvertedProjects\` | Converts the *App1.mpk* and *App2.mpk* app packages that are in the *C:\\Mendix\\* folder and puts the results in the *C:\\Mendix\\ConvertedProjects\\* folder. | | `mx convert --skip-error-check C:\Mendix\Packages\ C:\Mendix\ConvertedPackages\` | Converts all the app packages in the *C:\\Mendix\\Packages\\* folder to the *C:\\Mendix\\ConvertedPackages\\* folder without checking for errors. | @@ -182,7 +182,7 @@ These are the return codes: ## mx check Command {#check} -The `mx check` command checks the app *.mpr* file for issues such as errors, warnings, deprecations, or performance recommendations. +The `mx check` command checks the app *.mpr* file for errors, warnings, deprecations, and performance recommendations. {{% alert color="info" %}} The *.mpr* file must be the same version as the mx tool. @@ -201,7 +201,7 @@ These are the `OPTIONS`: | `--help`| | Shows help for the `mx check` command and exits. | | `--warnings` | `-w` | Includes warnings in the output. | | `--deprecations` | `-d` | Includes deprecations in the output. | -| `--performance` | `-p` | Includes performance checks in the output (performance recommendations are only outputted if there are no errors). | +| `--performance` | `-p` | Includes performance checks in the output. Performance recommendations are only included if there are no errors. | {{% alert color="info" %}} Errors in the *.mpr* are always reported. @@ -209,7 +209,7 @@ Errors in the *.mpr* are always reported. For `INPUT`, enter a single *.mpr* file. -You can optionally specify the path to an exported suppress-warnings (JSON) file. This means `mx check -w` will use the list of suppressed warnings in the JSON file, instead of the default behavior (which is to read from the *project-settings.user.json* file in the app directory). +You can optionally specify the path to an exported suppress-warnings (JSON) file. If specified, `mx check -w` uses the list of suppressed warnings in the JSON file instead of reading from the *project-settings.user.json* file in the app directory. ### Examples @@ -220,8 +220,8 @@ These are example commands: | `mx check --help` | Displays the help text for the check command. | | `mx check C:\MxProjects\App-main\App-main.mpr` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors. | | `mx check C:\MxProjects\App-main\App-main.mpr -p` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors and performance recommendations. | -| `mx check C:\MxProjects\App-main\App-main.mpr --warnings --deprecations` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors, warnings, and deprecations. Suppressed warnings will be read from the *project-settings.user.json* file within the app directory. | -| `mx check C:\MxProjects\App-main\App-main.mpr c:\MxFiles\my-exported-suppressed-warnings.json --warnings` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors and warnings. Suppressed warnings will be read from the JSON file *my-exported-suppressed-warnings.json*. | +| `mx check C:\MxProjects\App-main\App-main.mpr --warnings --deprecations` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors, warnings, and deprecations. Suppressed warnings are read from the *project-settings.user.json* file in the app directory. | +| `mx check C:\MxProjects\App-main\App-main.mpr c:\MxFiles\my-exported-suppressed-warnings.json --warnings` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors and warnings. Suppressed warnings are read from the JSON file *my-exported-suppressed-warnings.json*. | | `mx check C:\MxProjects\App-main\App-main.mpr -w -d -p` | Checks the app at *C:\MxProjects\App-main\App-main.mpr* for errors, warnings, deprecations, and performance recommendations. | ### Return Codes @@ -236,20 +236,19 @@ These are the return codes: | `4` | Deprecations were found. | | `8` | Performance recommendations were found. | -Those values are logically `OR` combined to indicate when there are a mix of errors, warnings, deprecations, or performance recommendations. +These values are logically combined with `OR` to indicate a mix of errors, warnings, deprecations, or performance recommendations. For example: -* `3` if errors and warnings found -* `7` if errors, warnings, and deprecations found +* `3` if errors and warnings are found +* `7` if errors, warnings, and deprecations are found ## mx translate Command {#translate} -The `mx translate` command allows you to export and import all translatable texts included in your Mendix application. -This command is currently in public beta. +The `mx translate` command exports and imports all translatable texts in your Mendix app. This command is currently in public beta. {{% alert color="warning" %}} -A limitation of this command is that the default behavior is to exclude Marketplace modules from the exported texts. When they are updated, the texts from a previous export will not be imported correctly. Your translations will also be lost when importing a new version of a Marketplace module. +By default, this command excludes Marketplace modules from the exported texts. When Marketplace modules are updated, texts from a previous export will not import correctly, and your translations will be lost when you import a new version of a Marketplace module. {{% /alert %}} {{% alert color="info" %}} @@ -266,21 +265,22 @@ These are the required parameters: | Option | Shortcut | Result | | --- | --- | --- | -| `--import-translations` | `-i` | Imports the translations from the directory specified as the translation directory. This is required if export is not specified. | -| `--export-translations` | `-e` | Exports the translations from the directory specified as the translation directory. This is required if import is not specified. | -| `--type` | `-t` | Specifies the file type to use. This can be either `xlsx` or `po`. | -| `--source-language-code`| `-s` | Specifies the ISO 639 language code to use (for example,`en_US` as the source language to translate from). This will be used as the text that needs to be translated. | +| `--import-translations` | `-i` | Imports translations from the specified translation directory. This is required if `--export-translations` is not specified. | +| `--export-translations` | `-e` | Exports translations to the specified translation directory. This is required if `--import-translations` is not specified. | +| `--type` | `-t` | Specifies the file type. This can be either `xlsx` or `po`. | +| `--source-language-code`| `-s` | Specifies the ISO 639 language code (for example, `en_US`) to use as the source language. | For `PROJECT`, enter a single *.mpr* file. -For `TRANSLATION_PATH`, enter a filepath to import or export the translation files from. + +For `TRANSLATION_PATH`, enter a file path to import or export the translation files. These are the `OPTIONS`: | Option | Shortcut | Result | | --- | --- | --- | -| `--force-import` | `-f` | Accepts some warnings and errors and tries to continue the import process. | -| `--loose-version-check` | `-l` | Converts the project to the version of the mx.exe, if it is a different version. | -| `--include-marketplace-modules` | `-m` | By default, the export does not include Marketplace modules. Adding this option will include them in the output. | +| `--force-import` | `-f` | Accepts some warnings and errors and continues the import process. | +| `--loose-version-check` | `-l` | Converts the project to the version of the mx.exe if the versions differ. | +| `--include-marketplace-modules` | `-m` | Includes Marketplace modules in the output. By default, Marketplace modules are excluded. | {{% alert color="info" %}} Errors in the *.mpr* are always reported. @@ -308,13 +308,12 @@ These are the return codes: ## mx sync-java-dependencies Command {#java-dependencies} -The `mx sync-java-dependencies` command synchronizes the managed Java dependencies that are configured in the modules of the project. -This results in the corresponding .*jar* files being added to the `vendorlib` directory in the project root. +The `mx sync-java-dependencies` command synchronizes the managed Java dependencies configured in the project modules. This adds the corresponding *.jar* files to the `vendorlib` directory in the project root. -The input is a single .*mpr* file. +The input is a single *.mpr* file. {{% alert color="info" %}} -The .*mpr* file must be the same version as mx. +The *.mpr* file must be the same version as the mx tool. {{% /alert %}} ### Usage @@ -339,5 +338,5 @@ These are the return codes: | Return Code | Description | | --- | --- | -| 0 | The command ran successfully. | -| 1 | The command failed. For example, because the *.mpr* file could not be found. | +| `0` | The command ran successfully. | +| `1` | The command failed, for example, because the *.mpr* file could not be found. | diff --git a/content/en/docs/refguide/general/mx-command-line-tool/dump-mpr.md b/content/en/docs/refguide/general/mx-command-line-tool/dump-mpr.md index 6ebb51905a4..b9306e2a6dd 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/dump-mpr.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/dump-mpr.md @@ -1,8 +1,8 @@ --- title: "MPR Dump" -url: /refguide/mx-command-line-tool/dump-mpr +url: /refguide/mx-command-line-tool/dump-mpr/ weight: 60 -description: "Describes the command used to create a JSON description of the model of a Mendix App." +description: "Describes the command used to create a JSON description of the model of a Mendix app." --- ## Introduction @@ -19,7 +19,7 @@ These are the `OPTIONS`: | Option | Value | Result | | --- | --- | --- | -| `--unit-type` | A single unit type, or a comma-separated list of unit types. To find a specific unit type, refer to the [Model SDK API documentation](https://apidocs.rnd.mendix.com/modelsdk/latest/index.html). Each unit includes a `structureTypeName` property that identifies its type. For example, the unit type for a [Page document](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Page.html#structureTypeName-1) is `Pages$Page`, as indicated in the documentation. Additionally, the unit type is included in the output JSON in the `$Type` field. You can use the command without this argument to list the unit types in your project. | Filters the results on the supplied unit types and limits the JSON export. | +| `--unit-type` | A single unit type, or a comma-separated list of unit types. To find a specific unit type, refer to the [Model SDK API documentation](https://apidocs.rnd.mendix.com/modelsdk/latest/index.html). Each unit includes a `structureTypeName` property that identifies its type. For example, the unit type for a [Page document](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Page.html#structureTypeName-1) is `Pages$Page`, as indicated in the documentation. Additionally, the unit type is included in the output JSON in the `$Type` field. You can use the command without this argument to list the unit types in your project. | Filters the results on the supplied unit types and limits the JSON export. | | `--exclude-system-module` | | Exclude the system module from the JSON export. | | `--exclude-protected-modules` | | Exclude protected modules from the JSON export. | | `--module-names` | A single module name, or a comma-separated list of module names. | Filters the results on the supplied modules and limits the JSON export. | diff --git a/content/en/docs/refguide/general/mx-command-line-tool/export.md b/content/en/docs/refguide/general/mx-command-line-tool/export.md index b0130384b6c..896dfd7960e 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/export.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/export.md @@ -1,13 +1,13 @@ --- title: "Export Package Commands" -url: /refguide/mx-command-line-tool/export +url: /refguide/mx-command-line-tool/export/ weight: 40 -description: "Describes the commands related to package export for the mx command-line tool." +description: "Describes commands that export different package types from your app using the mx command-line tool." --- ## Introduction -The commands in this group enable exporting different kinds of packages from your app. +The commands in this group export different package types from your app. ## mx create-project-package Command {#create-project-package} @@ -21,24 +21,22 @@ Use the following command pattern: These are the `OPTIONS`: -| Option | Result | +| Option | Description | | --- | --- | | `-s, --include-snapshot` | Includes a snapshot in the app package. | | `-d, --package-dir` | Exports the package to the directory. | -| `-k, --skip-managed-dependency-sync` | Do not synchronize managed dependencies; use existing files in `vendorlib` instead. | +| `-k, --skip-managed-dependency-sync` | Does not synchronize managed dependencies; uses existing files in `vendorlib` instead. | | `--help` | Displays the help screen. | For `TARGET-FILE`, specify the *.mpr* app you want to export. -### Examples - -Here is an example: +### Example `mx create-project-package c:\MyApps\MyApp.mpr` ### Return Codes -This table shows the return codes and their description: +This table shows the return codes and their descriptions: | Return Code | Description | | --- | --- | @@ -61,25 +59,23 @@ 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. | +| `-l, --filter-required-libs` | Includes all files except the userlibs that do not have an accompanying `[ModuleName].RequiredLib` file. | +| `-e, --exclude-files` | Excludes all files that match the given regular expression. | | `-d, --package-dir` | Exports the module package to the directory. | -| `-m, --exclude-managed-dependencies` | Excludes managed dependencies from synchronization and the exported module package. Note that this will prevent the module from being used if Gradle synchronization is disabled in Studio Pro. | +| `-m, --exclude-managed-dependencies` | Excludes managed dependencies from synchronization and the exported module package. This prevents the module from being used if Gradle synchronization is disabled in Studio Pro. | | `--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: +### Example `mx create-module-package c:\MyApps\MyApp.mpr Module1` ### Return Codes -This table shows the return codes and their description: +This table shows the return codes and their descriptions: | Return Code | Description | | --- | --- | @@ -101,24 +97,22 @@ Use the following command pattern: These are the `OPTIONS`: -| Option | Result | +| Option | Description | | --- | --- | | `-s, --include-snapshot` | Includes a snapshot in the app package. | | `-d, --package-dir` | Exports the package to the directory. | -| `-k, --skip-managed-dependency-sync` | Do not synchronize managed dependencies; use existing files in `vendorlib` instead. | +| `-k, --skip-managed-dependency-sync` | Does not synchronize managed dependencies; uses existing files in `vendorlib` instead. | | `--help` | Displays the help screen. | For `TARGET-FILE`, specify the *.mpr* app you want to export. -### Examples - -Here is an example: +### Example `mx create-solution-package c:\MyApps\MyApp.mpr` ### Return Codes -This table shows the return codes and their description: +This table shows the return codes and their descriptions: | Return Code | Description | | --- | --- | diff --git a/content/en/docs/refguide/general/mx-command-line-tool/merge.md b/content/en/docs/refguide/general/mx-command-line-tool/merge.md index 1a54792bf20..e203db43940 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/merge.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/merge.md @@ -1,13 +1,13 @@ --- title: "Merging and Diffing Commands" -url: /refguide/mx-command-line-tool/merge +url: /refguide/mx-command-line-tool/merge/ weight: 50 -description: "Describes the commands related to merging and diffing apps for the mx command-line tool." +description: "Describes the commands for comparing and merging apps using the mx command-line tool." --- ## Introduction -The commands in this group enable comparing two apps and merging them. +The commands in this group compare two apps and merge them. ## mx diff Command {#diff} @@ -24,16 +24,17 @@ These are the `OPTIONS`: | Option | Shortcut | Result | | --- | --- | --- | | `--help` | | Shows help for the `mx diff` command and exits. | -| `--loose-version-check` | `-l` | Makes the version check loose (meaning, it auto-converts if possible before diffing). | +| `--loose-version-check` | `-l` | Makes the version check loose. This auto-converts files if possible before comparing them. | -`BASE` is the first *.mpr* file, which is used as a base in comparison. +`BASE` is the first *.mpr* file, used as the base for comparison. -`MINE` is the second *.mpr* file, which is used as the changed version in comparison. The output will contain the changes that are in this file against the base. +`MINE` is the second *.mpr* file, used as the changed version for comparison. The output contains the changes in this file compared to the base. {{% alert color="info" %}} -For example, if the `BASE` *.mpr* has Microflow1 and the `MINE` *.mpr* does not have it, Microflow1 will be listed as deleted in the output file. If you swap the `BASE` and `MINE` parameters and compare again, Microflow1 will be listed as added.{{% /alert %}} +For example, if the `BASE` *.mpr* file contains Microflow1 and the `MINE` *.mpr* file does not contain it, Microflow1 is listed as deleted in the output file. If you swap the `BASE` and `MINE` parameters and compare again, Microflow1 is listed as added. +{{% /alert %}} -`OUTPUT` is the name of the outputted JSON file. +`OUTPUT` is the name of the output JSON file. ### Examples @@ -54,9 +55,9 @@ This table shows the return codes and their description: ## mx merge Command {#merge} -The `mx merge` command performs a three-way merge of two *.mpr* files by taking their common ancestor (base) into account. +The `mx merge` command performs a three-way merge of two *.mpr* files using their common ancestor (base). -The input is three *.mpr* files: `BASE`, `MINE`, and `THEIRS`. +The input is three *.mpr* files: `BASE`, `MINE`, and `THEIRS`. ### Usage @@ -70,9 +71,9 @@ These are the `OPTIONS`: | --- | --- | | `--help` | Shows help for the `mx merge` command and exits. | -`BASE` is common base version of the app. If the app is version-controlled, this is the last common revision of the app (the revision that is present in the history of both branches). +`BASE` is the common base version of the app. If the app is version-controlled, this is the last common revision of the app (the revision present in the history of both branches). -`MINE` is the version to merge into. This *.mpr* contains the results of the merge. +`MINE` is the version to merge into. This *.mpr* file contains the results of the merge. `THEIRS` is the version to merge changes from. @@ -82,32 +83,33 @@ The image below illustrates the meaning of the parameters: In the diagram, note the following: -* **A"** is `MINE`, which is the current commit you want to merge the changes to -* **B'** is `THEIRS`, which is the last commit on a branch you want to merge changes from -* **A** is `BASE`, which is the common commit where the branches diverged +* **A"** is `MINE`, the current commit you want to merge changes into +* **B'** is `THEIRS`, the last commit on the branch you want to merge changes from +* **A** is `BASE`, the common commit where the branches diverged -In order to merge changes correctly, Studio Pro has to compare both **A"** and **B'** against **A** to see what has been changed on each branch. During the merge, the [merge algorithm](/refguide/merge-algorithm/) will try to automatically merge the changes. +To merge changes correctly, Studio Pro compares both **A"** and **B'** against **A** to see what changed on each branch. During the merge, the [merge algorithm](/refguide/merge-algorithm/) attempts to automatically merge the changes. This command works for any three *.mpr* files. This means you can try to merge different apps at your own risk. {{% alert color="info" %}} -This command works differently than the normal version-controlled merges you can do in Studio Pro. While Studio Pro does a real merge of one branch into another, this command runs the merge algorithm over three *.mpr* files that do not even have to be version-controlled. {{% /alert %}} +This command works differently than the normal version-controlled merges you can do in Studio Pro. Studio Pro performs a true merge of one branch into another. In contrast, this command runs the merge algorithm on three *.mpr* files that do not need to be version-controlled. +{{% /alert %}} ### Conflicts If there are conflicts during the merge, resolve them by opening the app in Studio Pro and selecting **Version Control** > [Merge Changes Here](/refguide/version-control-menu/#merge-changes-here). -The reason for this is that conflict resolution is a complex process that has two requirements: +Conflict resolution is a complex process that has two requirements: -* The app has to be version-controlled -* Your Git repository has to be in the merge state (Studio Pro does this when you click **Merge Changes Here**) +* The app must be version-controlled. +* Your Git repository must be in the merge state. Studio Pro sets this when you click **Merge Changes Here**. -This merge state is needed for Studio Pro to know what your current branch is and which branch you are trying to merge into it. This way, when you are trying to resolve the conflict using the `THEIRS` document, Studio Pro can download the document from the branch and put it into your current app. +Studio Pro needs this merge state to identify your current branch and the branch you are merging into it. When you resolve the conflict using the `THEIRS` document, Studio Pro can download the document from the branch and add it to your current app. -So, if you run this command from the command line specifying the three *.mpr* files but the result has conflicts, you will not be able to resolve the conflicts in the `MINE` app using the `THEIRS` documents by just opening the app in Studio Pro. Instead, you need to configure Git to use `mx merge` as a [merge driver](#merge-git-driver) for the *.mpr* files and trigger the merge from the Git command line (so the repository is put in the merge state for Studio Pro to be able to pick it up after the command is complete). +If you run this command from the command line with three *.mpr* files and the result has conflicts, you cannot resolve the conflicts in the `MINE` app using the `THEIRS` documents by opening the app in Studio Pro. Instead, configure Git to use `mx merge` as a [merge driver](#merge-git-driver) for the *.mpr* files and trigger the merge from the Git command line. This puts the repository in the merge state so Studio Pro can access it after the command completes. {{% alert color="warning" %}} -`mx merge` as a [merge driver](#merge-git-driver) is suitable only for [MPRv1 Format](/refguide/troubleshoot-repository-size/#mpr-format) +Using `mx merge` as a [merge driver](#merge-git-driver) is suitable only for [MPRv1 Format](/refguide/troubleshoot-repository-size/#mpr-format). {{% /alert %}} ### Examples @@ -122,28 +124,28 @@ This table shows the return codes and their description: | Return Code | Description | | --- | --- | -| `0` | The merge is successful and there are no conflicts. *MINE.mpr* contains the result of the merge. | +| `0` | The merge is successful with no conflicts. *MINE.mpr* contains the merge result. | | `2` | Conflicts are detected. Open *MINE.mpr* in Studio Pro to resolve them. | -| `4` | The version is unsupported. | -| `129` | There is an exception, an error occurred during the merge. Error details are printed in the command line output. | +| `4` | The version is not supported. | +| `129` | An error occurred during the merge. Error details are printed in the command line output. | ## mx merge as Git Merge Driver {#merge-git-driver} {{% alert color="warning" %}} -`mx merge` as a [merge driver](#merge-git-driver) is suitable only for [MPRv1 Format](/refguide/troubleshoot-repository-size/#mpr-format) +Using `mx merge` as a [merge driver](#merge-git-driver) is suitable only for [MPRv1 Format](/refguide/troubleshoot-repository-size/#mpr-format). {{% /alert %}} {{% alert color="info" %}} Studio Pro configures the merge driver for an app with the name **studiopro** when opening it in Studio Pro. {{% /alert %}} -This section outlines the necessary configuration to enable the [mx merge](#merge) command as a merge driver in Git. With this configuration, you can merge one branch into another using third-party version control tools and the Git command line. +This section outlines the configuration needed to enable the [mx merge](#merge) command as a merge driver in Git. With this configuration, you can merge one branch into another using third-party version control tools and the Git command line. -Normally, when you are merging branches with Git, it compares the file changes in both branches. If a certain file has been changed in both branches, this triggers a conflict. If conflicting files are text files, Git attempts to resolve it automatically (very often successfully). +When you merge branches with Git, it compares the file changes in both branches. If a file changed in both branches, this triggers a conflict. If conflicting files are text files, Git attempts to resolve the conflict automatically and often succeeds. -However, if the conflicting files are Mendix apps, the conflict occurs in two .mpr files. Both the files and the conflict itself are more complex, which is why Studio Pro is needed to resolve them. +However, if the conflicting files are Mendix apps, the conflict occurs in two *.mpr* files. Both the files and the conflict itself are more complex, so you need Studio Pro to resolve them. -For such cases, Git provides an option to delegate conflict resolution for specific file types to an external tool. The `mx merge` command is designed to work with this mechanism, allowing Git to attempt merging the *.mpr* files as Studio Pro would. If conflicts remain, you can open Studio Pro and resolve them manually. +Git provides an option to delegate conflict resolution for specific file types to an external tool. The `mx merge` command works with this mechanism, allowing Git to attempt merging the *.mpr* files as Studio Pro would. If conflicts remain, you can open Studio Pro and resolve them manually. ### config File {#merge-config} @@ -201,11 +203,11 @@ CONFLICT (content): Merge conflict in MyBlankApp.mpr Automatic merge failed; fix conflicts and then commit the result. ``` -Now, if you open you app on the **Main** branch, you should see the following: +Now, if you open your app on the **Main** branch, you should see the following: -* Both the **branch** and **main** microflows (this is a non-conflicting change, so `mx merge` sorted this out automatically, just like Studio Pro would do) -* A conflict on the **Home_Web** page concerning the renaming of home page caption (this is a conflicting change, as you changed the same caption to different values on both branches, so you can resolve this manually) +* Both the **branch** and **main** microflows. This is a non-conflicting change, so `mx merge` resolved this automatically, just as Studio Pro would. +* A conflict on the **Home_Web** page concerning the home page caption. This is a conflicting change because you changed the same caption to different values on both branches. You can resolve this manually. {{% alert color="info" %}} -When you get a different output, the custom merge drive is not configured correctly. Abort the merge using the command `$git merge --abort` and close the Git command line tool before making changes to the configuration. Changes made to the configuration *config* and *.gitattributes* files are picked up by reopening the Git command line tool. +If you get different output, the custom merge driver is not configured correctly. Abort the merge using the command `$git merge --abort` and close the Git command line tool before making changes to the configuration. Changes made to the *config* and *.gitattributes* files are picked up when you reopen the Git command line tool. {{% /alert %}} diff --git a/content/en/docs/refguide/general/mx-command-line-tool/module.md b/content/en/docs/refguide/general/mx-command-line-tool/module.md index d498a94c544..c1e3206da1b 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/module.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/module.md @@ -1,6 +1,6 @@ --- title: "Module Commands" -url: /refguide/mx-command-line-tool/module +url: /refguide/mx-command-line-tool/module/ weight: 30 description: "Describes the module-related commands for the mx command-line tool." --- @@ -17,7 +17,7 @@ To see the command parameters for each command, use the `--help` parameter. For ## mx show-module-version Command {#show-module-version} -The `mx show-module-verion` command outputs the version of a module. +The `mx show-module-version` command outputs the version of a module. ### Usage @@ -48,7 +48,7 @@ The command will output the version of the module to the command line output. ## mx set-module-version Command {#set-module-version} -The `mx set-module-version` changes the version of an add-on module. +The `mx set-module-version` command changes the version of an add-on module. ### Usage @@ -115,7 +115,7 @@ In case of errors, the exit code consists of three digits `XYZ`: * 1 – Module you are trying to import is protected and cannot be imported. * 2 – Module you are trying to import is a Theme module and cannot be imported. - * 3 – Project already contains a module with the name as the module you are importing. Thus the module can't be imported. + * 3 – Project already contains a module with the same name as the module you are importing. Thus the module cannot be imported. * 4 – No module is found in the MPK package. * 5 – Project Version is not supported by the current version of mx.exe * 6 – Project can't be loaded diff --git a/content/en/docs/refguide/general/mx-command-line-tool/private-values.md b/content/en/docs/refguide/general/mx-command-line-tool/private-values.md index 65e341080f9..40bfa32ba2b 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/private-values.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/private-values.md @@ -85,7 +85,7 @@ When used without options, the command deletes all private values. The options f | `mx delete-private-values -n` | Shows all private values, but does not delete them (Same as `mx show-private-values`). | | `mx delete-private-values -f --not-on-disk` | Deletes all private values for which the path cannot be found on disk. This is useful when you have deleted one or more apps from your disk. | | `mx delete-private-values -f --path="C:\Users\John.Doe\Mendix\MyBikesApp\MyBikesApp-main.mpr" --version=10.12.0` | Deletes private values that were stored for the app `MyBikesApp-main.mpr` for Studio Pro version 10.12.0. This is useful after you have upgraded that app to a later version. | -| `mx delete-private-values -f --version=10.12.0` | Deletes private values for Studio Pro version 10.21.0. This is useful after you have upgraded all your apps to later versions. | +| `mx delete-private-values -f --version=10.12.0` | Deletes private values for Studio Pro version 10.12.0. This is useful after you have upgraded all your apps to later versions. | | `mx delete-private-values -f --item="C:\Users\John.Doe\Mendix\MyProductApp\MyProductApp-main.mpr 10.12.0 StudioPro.Settings.Configuration.ConstantValue.MyFirstModule.MyConstant"` | Deletes a specific private value (Same as specifying `--path=`, `version=` and `key=`). | ### Return Codes diff --git a/content/en/docs/refguide/general/mx-command-line-tool/security.md b/content/en/docs/refguide/general/mx-command-line-tool/security.md index 19b66079526..e2b3b6525a0 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/security.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/security.md @@ -17,11 +17,11 @@ The `mx export-security-overview` command can be used to export the data in the Use the following command pattern: `mx export-security-overview [OPTIONS] [MPR-FILE]` - `OPTIONS` are presented in the table below:: + `OPTIONS` are presented in the table below: | Option | Value | Result | |---------------------------|-------------------|----------| -| `-t, --export-format` | `json` or `xlsx` | The format to export to. | +| `-t, --export-format` | `json` or *xlsx* | The format to export to. | | `-e, --exclude-appstore` | *-* | When set, excludes Marketplace modules. | | `-o, --output-file` | file path | The path to the output file. |