You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,48 +22,72 @@ Mxcli is a tool that enables some of the following use cases.
22
22
23
23
## A textual DSL for mendix models
24
24
25
+
MDL, Mendix Definition Language, is a DSL that provides textual models at the same abstraction level as the visual models in Studio Pro.
26
+
25
27
26
28
27
29
### Command line tool to work with Mendix projects
28
30
31
+
Mxcli command line tool allows you to run commands against your project to investigate your project and make changes.
32
+
29
33
30
34
31
35
### A REPL to work with Mendix projects
32
36
37
+
In repl mode mxcli allows you to interactively work with a Mendix project. This is similar to psql or sqlplus when working with databases. You can list the available Mendix documents, view the MDL source, and make changes.
38
+
33
39
34
40
35
41
### Skills and configuration to enable Agentic Coding on Mendix projects
36
42
43
+
Running *mxcli init* will install configuration files for agentic coding tools like AGENTS.md, CLAUDE.md, and Mendix specific skills. It will also configure a devcontainer that you can use when opening the project in Vscode, so you limit what your agentic coder can impact and see.
44
+
37
45
38
46
47
+
This screenshot shows how Claude uses mxcli command to do agentic search on your Mendix project to understand what is available. It gets a list of pages that are in the specified module, it uses structure to get an overview of all the documents in the module, and then it describes the soure of a specifc page. Based on this info it can make a plan how to modify your project.
The skills documents teach agentic coding tools how to build Mendix projects. You can add your own skills with design patterns and best practices. Using MDL you can be very specific how the agent should generate the required Mendix documents.
54
+
43
55
44
56
45
57
### Metadata Catalog
46
58
59
+
Mxcli builds up a set of database tables with information about your project. This allows for flexible agentic search on your project documents.
60
+
47
61
48
62
49
63
### A Mendix project linter
50
64
65
+
The catalog tables are exposed as Starlark APIs so you can use the available data in custom Mendix linter rules.
66
+
51
67
52
68
53
69
### VSCode for Mendix projects
54
70
71
+
The easiest way to use mxcli is in vscode. You can run Claude Code inside vscode, mxcli installs a Mendix vscode extension that helps you review and understand your Mendix project. The project structure shows you all modules with document, similar to the app explorer in Mendix Studio Pro.
72
+
55
73
Claude code can start your Mendix project using PAD (portable application distribution). This will run the Mendix runtime in a docker container, and postgres in another docker container. This allows you to test your Mendix project without leaving vscode.
### Automated Playwright-cli testing for Mendix projects
64
84
85
+
The devcontainer is configured for use with playwright-cli so Claude Code can test your running application.
86
+
65
87
### Data migration for Mendix projects
66
88
89
+
Claude code can migrate existing data, or generate demo data in the postgres container when you run your application.
90
+
67
91
## Quick Start
68
92
69
93
The recommended way to use mxcli is inside a **Dev Container**. This sandboxes the AI agent so it can only access your project files, preventing unintended changes to your system. `mxcli init` sets up a `.devcontainer/` configuration automatically.
0 commit comments