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

Preface

This documentation covers mxcli, a command-line tool for reading, querying, and modifying Mendix application projects, and MDL (Mendix Definition Language), the SQL-like language it uses. Start with the Vision to understand where this project is headed. The material is organized into ten parts:

  • Part I: Tutorial walks you through installation, exploring a project, making your first changes, and integrating with AI assistants.
  • Part II: MDL by Example presents complete, self-contained examples – a CRM module, REST integration, data import, master-detail pages, validation, security, and more.
  • Part III: Migration covers AI-assisted migration of existing applications to Mendix – assessment, transformation, generation, data migration, and validation.
  • Part IV: The MDL Language is a comprehensive guide to MDL syntax – domain models, microflows, pages, security, navigation, workflows, and business events.
  • Part V: Project Tools covers code navigation, catalog queries, linting, testing, external SQL, and Docker integration.
  • Part VI: IDE Integration describes the VS Code extension, LSP server, and mxcli init project setup.
  • Part VII: Go Library documents the Go API for programmatic access to Mendix projects.
  • Part VIII: MDL Statement Reference provides detailed syntax and examples for every MDL statement.
  • Part IX: Architecture and Internals explains the MPR file format, parser pipeline, and catalog system for contributors.
  • Part X: Appendixes includes quick reference tables, reserved words, error messages, and a glossary.

You can read the Tutorial sequentially or jump directly to the section relevant to your task. The Statement Reference (Part VI) is designed for lookup rather than linear reading.