mxcli Playground

A ready-to-use Mendix project for exploring mxcli -- a command-line tool for reading and modifying Mendix apps using MDL (Mendix Definition Language).

Quick Start

1. Click "Open in GitHub Codespaces" above (or clone locally with mxcli installed)
2. Wait for the environment to set up (~2 minutes on first launch)
3. Start using mxcli:

# Explore the project
mxcli -p App.mpr -c "SHOW STRUCTURE"
mxcli -p App.mpr -c "SHOW ENTITIES IN MyFirstModule"

# Run an example script
mxcli exec scripts/01-explore.mdl -p App.mpr

# Start interactive REPL
mxcli
# Then: CONNECT LOCAL 'App.mpr';

What's Included

Sample Mendix Project

A Mendix 11.x blank project (App.mpr) with the standard template modules, ready for you to build on.

Example Scripts

Script	Description
scripts/01-explore.mdl	Explore project structure, list modules and entities
scripts/02-create-entity.mdl	Create entities with attributes and associations
scripts/03-create-microflow.mdl	Build microflows with activities and logic
scripts/04-create-page.mdl	Create pages with widgets and data views
scripts/05-security.mdl	Configure security roles and access rules

Run any script with:

mxcli exec scripts/02-create-entity.mdl -p App.mpr

Tutorials

Step-by-step guides in the tutorials/ folder:

1. Getting Started -- First steps with mxcli
2. Domain Modeling -- Building a domain model
3. CRUD Pages -- Creating overview and edit pages
4. Microflow Logic -- Writing business logic
5. Linting & Testing -- Quality checks

Using with AI Assistants

This project is pre-configured for AI-assisted development:

Tool	Configuration
Claude Code	.claude/ commands + CLAUDE.md
Cursor	.cursorrules
Windsurf	.windsurfrules
Continue.dev	.continue/config.json
Aider	.aider.conf.yml

Skills and patterns are in .ai-context/skills/ and referenced from AGENTS.md.

Claude Code Slash Commands

If using Claude Code, these commands are available:

Command	Description
/explore	Explore project structure
/create-entity	Guided entity creation
/create-crud	Generate CRUD pages
/lint	Run project linting
/check-script	Validate MDL syntax
/validate-project	Run Mendix validation (mx check)

Validate Your Changes

After modifying the project, validate it:

# Check MDL script syntax
mxcli check script.mdl

# Check with reference validation
mxcli check script.mdl -p App.mpr --references

# Run Mendix validation (same checks as Studio Pro)
~/.mxcli/mxbuild/*/modeler/mx check App.mpr

Version Info

Component	Version	Updated
Mendix	See .mendix-version	Automatically tracked weekly
mxcli	See .mxcli-version	Updated on each mxcli release

Both are kept up to date via automated GitHub Actions workflows.

Links

• mxcli repository
• MDL Quick Reference
• Mendix Documentation