mx Command-Line Tool

Last modified: December 4, 2023

1 Introduction

The mx tool is a Windows and Linux command-line tool that can be used to perform various actions on a Mendix app.

2 Location

Mendix Studio Pro comes with the mx command-line tool. You can find the executable mx.exe file can in the same folder that contains studiopro.exe (for example, C:\Program Files\Mendix\10.0.0.5003\modeler\mx.exe). It is also included if you download mxbuild.

3 Available Commands

3.1 App Commands

These are the available app commands:

Command Description
check Checks the app for issues.
convert Converts the Mendix app.
create-project Creates a new Mendix app.
show-version Shows the Studio Pro version that was last used to edit the app.

3.2 Adaptable Solutions Commands

These are the available adaptable solutions commands:

Command Description
show-app-version Shows the application version of the app.
set-app-version Sets the application version of the app.

3.3 Module Commands

These are the available module commands:

Command Description
show-module-version Shows the version of a module.
set-module-version Sets the version of a module.
module-import Import a module from an mpk package into an app.

3.4 Export Package Commands

These are the available export package commands:

Command Description
create-project-package Exports an app package.
create-solution-package Exports a solution package.
create-module-package Exports a module package.

3.5 Merging and Diffing Commands

These are the available merging and diffing commands:

Command Description
merge Merges the .mpr files.
diff Shows the diff of the .mpr files.
dump-mpr Create a JSON description of the model of a Mendix App

4 Undocumented Options

The mx tool contains options that are not described in this document. Those are for internal Mendix usage and are not officially supported. This might change in the future, but these options are used at your own risk.