Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Docker Integration

mxcli provides Docker integration for building, running, and validating Mendix applications without a local Mendix installation. Docker is also required for the testing framework.

Features

CommandDescription
mxcli docker buildBuild a Mendix application with mxbuild in Docker, including PAD patching
mxcli docker runRun a Mendix application in a Docker container
mxcli docker checkValidate a project with mx check (auto-downloads mxbuild)
mxcli testRun test files (uses Docker for mx create-project and mx check)
mxcli oqlQuery a running Mendix runtime via M2EE admin API

Prerequisites

  • Docker must be installed and running
  • The Docker daemon must be accessible from the command line

The mx Tool

The mx command-line tool validates and builds Mendix projects. mxcli can auto-download the correct version:

# Auto-download mxbuild for the project's Mendix version
mxcli setup mxbuild -p app.mpr

The mx binary location depends on the environment:

EnvironmentPath
Dev container~/.mxcli/mxbuild/{version}/modeler/mx
Repositoryreference/mxbuild/modeler/mx

Quick Start

# Validate a project
mxcli docker check -p app.mpr

# Build a deployable package
mxcli docker build -p app.mpr