Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down
46 changes: 23 additions & 23 deletions content/en/docs/refguide/general/mx-command-line-tool/adaptable.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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. |

Expand All @@ -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. |
Original file line number Diff line number Diff line change
Expand Up @@ -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\<version>\modeler\MprTool.exe* (where <version> 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\<version>\modeler\MprTool.exe* (replace <version> 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:
<details>

<summary>Expand for code sample</summary>
Expand Down
Loading