Mendix CLI

A set of Command line interface tools for Mendix developers, CICD engineers and platform engineers.

This project is in early development stage. Please use with caution. We are looking for contributors to help us improve the tools. Please create a PR with your changes. We believe in open ecosystem and open source. We are looking forward to your contributions. These can be documentation improvements, bug fixes, new features, etc.

Quick start

Mendix-cli is a set of tools to help you with your Mendix projects. As such you can use it in many ways. To give you a feeling what it does. Try the following example:

Prerequisites

• Mendix Project source
• Operating system: Linux, MacOS, Windows
• Download your platform specific binary from the releases page
• Download the policies from the releases page and extract them to a directory

Export Mendix model to Yaml

• copy mendix-cli to your project directory
• Open a terminal and navigate to your project directory; ideally use git-bash on Windows or Terminal on MacOS/Linux
• run ./mendix-cli export-model

You will see a new directory modelsource with the exported Mendix model in Yaml format

It's advisable to add the mendix-cli file to your .gitignore file. This way you don't accidentally commit it to your repository.

Lint Mendix Yaml files

• copy policies directory to your project directory
• run ./mendix-cli lint --xunit-report=report.xml

You will see a summary of the policy evaluations in the terminal and a report in the report.xml file. The report is in xUnit format. You can use it in your CI/CD pipeline.

Do you want to create your own policies? Please refer to our guide Create new policy

export-model

Mendix models are stored in a binary file with .mpr extension. This project exports Mendix model to a human readable format, such as Yaml. This enables developers to use traditional code analysis tools on Mendix models. Think of quality checks like linting, code formatting, etc.

See each Mendix document/object as a separate file in the output directory. And see the differences between versions in a version control system. Here we changed the Documentation of an entity and added a new Entity with one Attribute.

pre-commit hook setup

As of this writing, Mendix Studio Pro does not support Git hooks. You can use the following workaround to automatically export your Mendix model to Yaml before each commit. Make sure you have git-bash installed on your system. It is already present if you use Mendix 10. If you don't have it, download from here.

Open git-bash inside of your project directory (use cd Mendix/project-name if needed) and run the following commands:

curl https://github.com/cinaq/mendix-cli/raw/main/pre-commit -o .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

# try it out
.git/hooks/pre-commit

Now whenever you commit using git-bash, the Mendix model will be exported to Yaml before the commit. The changes will be included automatically.

Pipeline integration

If you do not want to export the model to Yaml on your local machine, you can do it in your pipeline. Here's a high-level example:

$ ./bin/mendix-cli-darwin-arm64 export-model -i resources/full-app-v1.mpr
INFO[0000] Exporting resources/full-app-v1.mpr to modelsource
INFO[0000] Completed resources/full-app-v1.mpr

$ ./bin/mendix-cli-darwin-arm64 lint
## policies/001_project_settings/001_0001_anonymous_disabled.rego
PASS (0.00148s) modelsource/Security$ProjectSecurity.yaml

## policies/001_project_settings/001_0002_demo_users_disabled.rego
SKIP (0.00000s) modelsource/Security$ProjectSecurity.yaml

## policies/001_project_settings/001_0003_security_checks.rego
SKIP (0.00000s) modelsource/Security$ProjectSecurity.yaml

## policies/001_project_settings/001_0004_strong_password.rego
SKIP (0.00000s) modelsource/Security$ProjectSecurity.yaml

## policies/002_domain_model/002_0001_number_of_entities.rego
PASS (0.00190s) modelsource/Administration/DomainModels$DomainModel.yaml
PASS (0.00156s) modelsource/Atlas_UI_Resources/DomainModels$DomainModel.yaml
PASS (0.00240s) modelsource/MyFirstModule/DomainModels$DomainModel.yaml

## policies/002_domain_model/002_0002_number_of_attributes.rego
PASS (0.00161s) modelsource/Administration/DomainModels$DomainModel.yaml
PASS (0.00113s) modelsource/Atlas_UI_Resources/DomainModels$DomainModel.yaml
PASS (0.00158s) modelsource/MyFirstModule/DomainModels$DomainModel.yaml

lint

Lint Mendix Yaml files. This tool checks for common mistakes and enforces best practices. It uses OPA as policy engine. Therefore policies must be written in the powerful Rego language. Please refer to Rego language reference for more information on the syntax and semantics.

Features

• Export Mendix model to Yaml
• Lint Mendix Yaml files for common mistakes and enforces best practices
• Incremental changes
• Human readable output

TODO

• Export Mendix model to Yaml
• Improve output human readability
• Linting for Mendix Yaml files
• Create policies for linting
• Output linting results in xUnit format
• Expand test coverage
• Support incremental changes
• Improve performance for large models
• Improve error handling
• Transform flows (activities, decisions, etc.) to pseudo code

Contribute

Create a PR with your changes. We will review and merge it.

Rego files must follow the style guide

Make sure to run the tests before creating a PR:

make test

License

This project is an initiative of CINAQ. See LICENSE. CINAQ is a registered trademark of CINAQ B.V.. Mendix is a registered trademark of Mendix B.V. All other trademarks are the property of their respective owners.