mxcli

https://www.mxcli.org
Admin
mxcli is a command-line tool for reading, querying, and modifying Mendix application projects using...
Tokens:450,581
Snippets:4,635
Trust Score:2.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Setup: Open model and set module

Source: https://www.mxcli.org/library/fluent-examples.html

All examples start with this setup. It opens a Mendix model file, retrieves a module by name, and sets it as the current module for subsequent operations.

```go
package main

import (
    "log"
    "github.com/mendixlabs/mxcli/api"
)

func main() {
    modelAPI, err := api.Open("/path/to/MyApp.mpr")
    if err != nil {
        log.Fatal(err)
    }
    defer modelAPI.Close()

    module, _ := modelAPI.Modules.Get("Sales")
    modelAPI.SetModule(module)

    // ... examples below
}
```

--------------------------------

### Complete demo user setup example

Source: https://www.mxcli.org/language/demo-users.html

Enables demo users, sets prototype security, and creates demo accounts for each role. The mdl 1; line is required.

```mx
mdl 1;
-- Enable demo users and set prototype security
ALTER APP SECURITY ( SecurityLevel: PROTOTYPE );
ALTER APP SECURITY ( EnableDemoUsers: TRUE );

-- Create demo accounts for each role
CREATE DEMO USER 'demo_admin' ( Password: 'Admin123!', Entity: Administration.Account, UserRoles: (Administrator) );
CREATE DEMO USER 'demo_user' ( Password: 'User1234!', Entity: Administration.Account, UserRoles: (Employee) );
CREATE DEMO USER 'demo_guest' ( Password: 'Guest123!', Entity: Administration.Account, UserRoles: (Guest) );
```

--------------------------------

### Typical Security Setup Script

Source: https://www.mxcli.org/language/grant-revoke.html

A typical security setup script that creates module roles, user roles, entity access, microflow/page permissions, demo users, and enables demo users. This script is an example of a complete security configuration.

```sql
mdl 1;
-- Module roles
CREATE MODULE ROLE Shop.Admin DESCRIPTION 'Full access';
CREATE MODULE ROLE Shop.User DESCRIPTION 'Standard access';
CREATE MODULE ROLE Shop.Viewer DESCRIPTION 'Read-only access';

-- User roles
CREATE USER ROLE Administrator ( ModuleRoles: (Shop.Admin, System.Administrator), ManageAllRoles: true );
CREATE USER ROLE Employee ( ModuleRoles: (Shop.User) );
CREATE USER ROLE Guest ( ModuleRoles: (Shop.Viewer) );

-- Entity access
GRANT CREATE, DELETE, READ *, WRITE * ON ENTITY Shop.Customer TO Shop.Admin;
GRANT READ *, WRITE (Email, Phone) ON ENTITY Shop.Customer TO Shop.User;
GRANT READ * ON ENTITY Shop.Customer TO Shop.Viewer;

GRANT CREATE, DELETE, READ *, WRITE * ON ENTITY Shop.Order TO Shop.Admin;
GRANT CREATE, READ *, WRITE * ON ENTITY Shop.Order TO Shop.User
  WHERE [Status = 'Open'];
GRANT READ * ON ENTITY Shop.Order TO Shop.Viewer;

-- Microflow access
GRANT EXECUTE ON MICROFLOW Shop.ACT_ProcessOrder TO Shop.Admin;
GRANT EXECUTE ON MICROFLOW Shop.ACT_CreateOrder TO Shop.User, Shop.Admin;
GRANT EXECUTE ON MICROFLOW Shop.ACT_ViewOrders TO Shop.User, Shop.Admin, Shop.Viewer;

-- Page access
GRANT VIEW ON PAGE Shop.Order_Overview TO Shop.User, Shop.Admin, Shop.Viewer;
GRANT VIEW ON PAGE Shop.Order_Edit TO Shop.User, Shop.Admin;
GRANT VIEW ON PAGE Shop.Admin_Dashboard TO Shop.Admin;

-- Demo users
CREATE DEMO USER 'demo_admin' ( Password: 'Admin123!', UserRoles: (Administrator) );
CREATE DEMO USER 'demo_user' ( Password: 'User123!', UserRoles: (Employee) );

-- Enable demo users
ALTER APP SECURITY ( EnableDemoUsers: TRUE );
ALTER APP SECURITY ( SecurityLevel: PROTOTYPE );
```

--------------------------------

### Run read_project example

Source: https://www.mxcli.org/library/reading.html

Commands to run the read_project example, passing the path to a .mpr file.

```bash
cd examples/read_project
go run main.go /path/to/MyApp.mpr
```

--------------------------------

### Declare @setup in the file header comment

Source: https://www.mxcli.org/tools/test-annotations.html

Declare @setup once in the file's header comment and every test in the file gets it, the file's fixtures first. A header may carry only @setup; @expect, @verify, @throws and @cleanup are refused by name.

```mendix
_
/**
 * Seeds every test below.
 * @setup eShop.ACT_SeedCatalog
 */
```

--------------------------------

### Install mxcli with go get

Source: https://www.mxcli.org/library/installation.html

Installs the mxcli library using the Go package manager. Requires Go 1.21+ and no C compiler because the project uses modernc.org/sqlite.

```bash
go get github.com/mendixlabs/mxcli

```

--------------------------------

### Start broad with SHOW: list modules and entities

Source: https://www.mxcli.org/tutorial/describe-search.html

Use these commands to get a broad overview of the project structure. LIST MODULES shows all modules, and LIST ENTITIES IN Sales lists entities within the Sales module.

```mendix
LIST MODULES;
LIST ENTITIES IN Sales;
```

--------------------------------

### Alter configuration settings examples

Source: https://www.mxcli.org/language/project-settings.html

Examples of server configuration changes for the 'default' configuration.

```mdl
mdl 1;
```

```mdl
ALTER SETTINGS CONFIGURATION 'default' ( DatabaseType: 'POSTGRESQL' );
```

```mdl
ALTER SETTINGS CONFIGURATION 'default' ( DatabaseUrl: 'jdbc:postgresql://localhost:5432/myapp' );
```

```mdl
ALTER SETTINGS CONFIGURATION 'default' ( HttpPortNumber: '8080' );
```

--------------------------------

### Start MDL language server with mxcli lsp --stdio

Source: https://www.mxcli.org/ide/lsp.html

Starts the MDL language server over standard I/O using JSON-RPC. The server is built into the mxcli binary, so no separate installation is needed.

```bash
mxcli lsp --stdio
```

--------------------------------

### Install a local .mpk with mxcli marketplace install --file

Source: https://www.mxcli.org/guides/marketplace.html

Use --file to install a package that is not from the marketplace, such as an internal or company-standard module, a theme module, a previously downloaded package, or a CI job without a token. It runs through the same writer as an online install, with no marketplace lookup and no PAT.

```bash
mxcli marketplace install --file ./CompanyTheme.mpk -p app.mpr
```

--------------------------------

### Setup and run mxcli tunnel-hub and app preview

Source: https://www.mxcli.org/tools/run-local.html

Commands to start the tunnel hub on a VPS and connect a local Mendix application to it.

```bash
# on your VPS: *.example.com + hub.example.com -> this host, inbound 80+443 open
mxcli tunnel-hub --domain example.com --secret alice:s3cret

# where the app runs:
mxcli run --hub https://hub.example.com --hub-secret alice:s3cret -p app.mpr
#   -> registers and prints e.g. "Preview available at https://app.example.com"
```

--------------------------------

### Install marketplace packages with mxcli marketplace install

Source: https://www.mxcli.org/guides/marketplace.html

Downloads a widget or module from the marketplace and places it according to its type. A widget is copied into the project's widgets/ folder (overwrites on update); a module is written with mxcli's own writer preserving the MPR format. Reload in Studio Pro or run `mx update-widgets` to pick up a widget, and run `mxcli setup mxbuild -p app.mpr` if a matching mxbuild is missing.

```bash
mxcli marketplace install 20 -p app.mpr               # a widget
mxcli marketplace install 2888 --version 7.0.3 -p app.mpr   # a module
```

--------------------------------

### Version stamp file example

Source: https://www.mxcli.org/ide/syncing.html

Example content of `.ai-context/mxcli-tooling.json`. It is rewritten only when the version changes.

```json
{
  "version": "v0.25.0",
  "built": "2026-10-01T09:12:44Z",
  "written": "2026-10-03"
}
```

--------------------------------

### opencode.json Configuration Example

Source: https://www.mxcli.org/tutorial/opencode.html

Example `opencode.json` configuration. Points to AGENTS.md and both OpenCode-format skills and universal skill files.

```json
{
  "$schema": "https://opencode.ai/config.json",
  "instructions": [
    "AGENTS.md",
    ".opencode/skills/**/SKILL.md",
    ".ai-context/skills/*/SKILL.md"
  ]
}
```

--------------------------------

### Create knowledge base example

Source: https://www.mxcli.org/reference/agent/create-knowledge-base.html

Example of creating a knowledge base named MyModule."ProductDocs" with a key constant MyModule."KBKey". The constant is defined with an empty default value.

```mx
mdl 1;
CREATE CONSTANT MyModule."KBKey"
    ( Type: String, DefaultValue: '' );

CREATE KNOWLEDGE BASE MyModule."ProductDocs" (
    Provider: MxCloudGenAI,
    key: @MyModule.KBKey
);
```

--------------------------------

### CALL WORKFLOW example

Source: https://www.mxcli.org/language/workflow-activities.html

Example of starting a sub-workflow named HR.BackgroundCheck with a caption.

```Mendix
CALL WORKFLOW HR.BackgroundCheck CAPTION 'Run background check sub-process';
```

--------------------------------

### AutoNumber attribute examples

Source: https://www.mxcli.org/language/primitive-types.html

Example AutoNumber attribute declarations. The DEFAULT value specifies the starting number; typically combined with NOT NULL and UNIQUE constraints.

```mdl
OrderId: AutoNumber NOT NULL UNIQUE DEFAULT 1
CustomerId: AutoNumber
```

--------------------------------

### Complete SQL workflow example

Source: https://www.mxcli.org/tools/sql-query.html

Shows connecting to a PostgreSQL database, exploring schema, running queries, aggregations, joins, and DDL. Demonstrates the full workflow from connection to querying.

```sql
__
-- Connect
SQL CONNECT postgres 'postgres://user:pass@localhost:5432/mydb' AS source;

-- Explore schema
SQL source SHOW TABLES;
SQL source DESCRIBE employees;

-- Simple queries
SQL source SELECT * FROM employees WHERE active = true LIMIT 10;

-- Aggregation
SQL source SELECT department, COUNT(*) as cnt FROM employees GROUP BY department ORDER BY cnt DESC;

-- Joins
SQL source SELECT e.name, d.name AS department
  FROM employees e
  JOIN departments d ON e.dept_id = d.id
  WHERE e.active = true;

-- DDL (if you have permissions)
SQL source CREATE INDEX idx_employees_email ON employees(email);

```

--------------------------------

### Download mxcli and unpack skills

Source: https://www.mxcli.org/tools/bootstrap-prompt.html

Steps 1 and 2 of the bootstrap prompt: download the prebuilt mxcli binary for Linux amd64 and make it executable, then unpack the skills that ship inside it. The init command needs no project, so it works in an empty repo.

```bash
curl -fsSL -o ./mxcli \
  https://github.com/mendixlabs/mxcli/releases/download/nightly/mxcli-linux-amd64
chmod +x ./mxcli
```

```bash
./mxcli init --sync-skills
```

--------------------------------

### Valid identifier examples

Source: https://www.mxcli.org/language/qualified-names.html

Shows valid identifier examples: an underscore, a name with underscore, and a name with digits. Identifiers must start with a letter or underscore and may contain letters, digits, and underscores.

```text
MyEntity
my_attribute
Attribute123
```

--------------------------------

### CREATE DEMO USER examples

Source: https://www.mxcli.org/language/demo-users.html

Examples of creating demo users with various options: basic, with explicit entity, multiple roles, and standard user. The mdl 1; line is required.

```mx
mdl 1;
-- Basic demo user
CREATE DEMO USER 'demo_admin' ( Password: 'Admin123!', UserRoles: (Administrator) );

-- With explicit entity
CREATE DEMO USER 'demo_admin' ( Password: 'Admin123!', Entity: Administration.Account, UserRoles: (Administrator) );

-- Multiple roles
CREATE DEMO USER 'demo_manager' ( Password: 'Manager1!', UserRoles: (Manager, Reporting) );

-- Standard user
CREATE DEMO USER 'demo_user' ( Password: 'User1234!', UserRoles: (Employee) );
```

--------------------------------

### Install VS Code extension from VSIX file

Source: https://www.mxcli.org/ide/vscode-installation.html

Install the extension directly from a VSIX file using the VS Code CLI. This is useful when you already have the VSIX file, for example from the mxcli build artifacts.

```bash
code --install-extension vscode-mdl/vscode-mdl-*.vsix
```

--------------------------------

### LIST SETTINGS example

Source: https://www.mxcli.org/reference/settings/list-describe-settings.html

Lists all settings across all categories in a compact overview.

```mdl
LIST SETTINGS;
```

--------------------------------

### DESCRIBE NAVIGATION example

Source: https://www.mxcli.org/reference/navigation/list-navigation.html

Exports the Responsive profile as MDL.

```mxcli
__
DESCRIBE NAVIGATION Responsive;

```

--------------------------------

### Verify mxcli installation with mxcli --version

Source: https://www.mxcli.org/tutorial/installation.html

Run this command to verify that mxcli is installed and accessible. It prints version and build information to the terminal. If you get a 'command not found' error, check that the binary is on your PATH.

```bash
mxcli --version
```

--------------------------------

### DESCRIBE SETTINGS example

Source: https://www.mxcli.org/reference/settings/list-describe-settings.html

Outputs the full settings in round-trippable MDL syntax for all categories.

```mdl
DESCRIBE SETTINGS;
```

--------------------------------

### CLAUDE.md project instructions example

Source: https://www.mxcli.org/guides/customizing-ai.html

Example `CLAUDE.md` file that AI assistants read first. Contains team conventions for naming, architecture, security, and module structure. Add your own conventions here to guide AI-generated Mendix code.

```markdown
# Project Instructions

## Naming Conventions
- Entity names: PascalCase, singular (Customer, not Customers)
- Microflow names: ACT_ prefix for button actions, SUB_ for sub-microflows
- Page names: P_ prefix followed by action and entity (P_Customer_Overview)
- Attribute names: PascalCase (FirstName, not first_name)

## Architecture Rules
- All database queries go through a DAL_ (Data Access Layer) microflow
- Never commit objects inside a loop
- Use sub-microflows for logic blocks over 10 activities
- Every entity must have a Name or Description attribute for display

## Security
- Default: no access. Explicitly grant access for each role.
- Admin role gets full access
- User role gets read-only on reference data

## Module Structure
- Core: domain model, enumerations, constants
- API: REST services, consumed services
- UI: pages, snippets, layouts
- Logic: microflows, nanoflows
```

--------------------------------

### Complete example: create entities, association, enumeration, and microflow

Source: https://www.mxcli.org/library/fluent-api.html

Full example that opens a model, sets the module, creates two entities, an association, an enumeration, and a microflow using the fluent API.

```go
package main

import (
    "github.com/mendixlabs/mxcli/api"
)

func main() {
    modelAPI, err := api.Open("/path/to/MyApp.mpr")
    if err != nil {
        panic(err)
    }
    defer modelAPI.Close()


    module, _ := modelAPI.Modules.Get("MyModule")
    modelAPI.SetModule(module)

    // Create entity with fluent builder
    customer, _ := modelAPI.DomainModels.CreateEntity("Customer").
        Persistent().
        WithStringAttribute("Name", 100).
        WithStringAttribute("Email", 254).
        WithIntegerAttribute("Age").
        WithBooleanAttribute("IsActive").
        WithDateTimeAttribute("CreatedDate").
        Build()

    // Create another entity
    order, _ := modelAPI.DomainModels.CreateEntity("Order").
        Persistent().
        WithDecimalAttribute("TotalAmount").
        WithDateTimeAttribute("OrderDate").
        Build()

    // Create association between entities
    _, _ = modelAPI.DomainModels.CreateAssociation("Customer_Orders").
        From("Customer").
        To("Order").
        OneToMany().
        Build()

    // Create enumeration
    _, _ = modelAPI.Enumerations.CreateEnumeration("OrderStatus").
        WithValue("Pending", "Pending").
        WithValue("Processing", "Processing").
        WithValue("Completed", "Completed").
        WithValue("Cancelled", "Cancelled").
        Build()

    // Create microflow
    _, _ = modelAPI.Microflows.CreateMicroflow("ACT_ProcessOrder").
        WithParameter("Order", "MyModule.Order").
        WithStringParameter("Message").
        ReturnsBoolean().
        Build()
}
```

--------------------------------

### Search products with query parameters via REST GET

Source: https://www.mxcli.org/examples/rest-integration.html

Use when calling a REST GET endpoint with URL query parameters. The example builds a query string from two parameters, URL-encoding the first and converting the second to a string, with a 60-second timeout.

```Mendix
CREATE MICROFLOW Integration.SearchProducts (
  $Query: String,
  $Page: Integer
)
RETURNS String AS $Response
BEGIN
  $Response = CALL REST SERVICE GET 'https://api.example.com/search?q={1}&page={2}' WITH (
    {1} = urlEncode($Query),
    {2} = toString($Page)
  ) (
    Headers: ('Accept': 'application/json'),
    Timeout: 60,
  ) RETURNS String;
  RETURN $Response;
END;
```

--------------------------------

### Pipe search results to describe

Source: https://www.mxcli.org/tools/search.html

Pipeline example: search for 'error', extract the first result name, and pass it to mxcli describe to get details about the microflow.

```bash
# Find the first microflow matching "error" and describe it
mxcli search -p app.mpr "error" -q --format names | head -1 | awk '{print $2}' | \
  xargs mxcli describe -p app.mpr microflow
```

--------------------------------

### LIST NAVIGATION MENU example

Source: https://www.mxcli.org/reference/navigation/list-navigation.html

Shows the menu tree for the Responsive profile.

```mxcli
__
LIST NAVIGATION MENU Responsive;

```

--------------------------------

### LIST NAVIGATION summary example

Source: https://www.mxcli.org/reference/navigation/list-navigation.html

Shows a summary of all profiles.

```mxcli
__
LIST NAVIGATION;

```

--------------------------------

### Emacs Eglot setup for MDL

Source: https://www.mxcli.org/ide/lsp-editors.html

Configure the MDL language server in Emacs using Eglot. Adds a server program entry for mdl-mode and ensures Eglot starts on mdl-mode.

```emacs-lisp
(add-to-list 'eglot-server-programs
             '(mdl-mode . ("mxcli" "lsp" "--stdio")))

(add-hook 'mdl-mode-hook #'eglot-ensure)
```

--------------------------------

### Read Mendix project: list modules, entities, microflows, pages

Source: https://www.mxcli.org/library/reading.html

Full Go example demonstrating how to open a Mendix project and enumerate modules, domain model entities/attributes, microflows, and pages. Errors are ignored for brevity; reading is read-only and uses lazy loading.

```go
package main

import (
    "fmt"
    "github.com/mendixlabs/mxcli"
)

func main() {
    // Open a Mendix project
    reader, err := modelsdk.Open("/path/to/MyApp.mpr")
    if err != nil {
        panic(err)
    }
    defer reader.Close()

    // List all modules
    modules, _ := reader.ListModules()
    for _, m := range modules {
        fmt.Printf("Module: %s\n", m.Name)
    }

    // Get domain model for a module
    dm, _ := reader.GetDomainModel(modules[0].ID)
    for _, entity := range dm.Entities {
        fmt.Printf("  Entity: %s\n", entity.Name)
        for _, attr := range entity.Attributes {
            fmt.Printf("    - %s: %s\n", attr.Name, attr.Type.GetTypeName())
        }
    }

    // List microflows
    microflows, _ := reader.ListMicroflows()
    fmt.Printf("Total microflows: %d\n", len(microflows))

    // List pages
    pages, _ := reader.ListPages()
    fmt.Printf("Total pages: %d\n", len(pages))
}
```

--------------------------------

### Starlark rules installation directory structure

Source: https://www.mxcli.org/tools/starlark-rules.html

Shows the directory layout created by `mxcli init` for Starlark rules, including example rule files like sec004_guest_access.star, arch001_cross_module.star, and qual001_complexity.star.

```text
your-project/
└── .claude/
    └── lint-rules/
        ├── sec004_guest_access.star
        ├── arch001_cross_module.star
        ├── qual001_complexity.star
        └── ...
```

--------------------------------

### Set up MxBuild and check project with mxcli

Source: https://www.mxcli.org/appendixes/version-compatibility.html

Use these commands to set up the correct MxBuild version for the project and then check the project with the mx validation tool. The MxBuild version is auto-downloaded and cached in ~/.mxcli/mxbuild/{version}/.

```bash
# Auto-download the correct MxBuild version
mxcli setup mxbuild -p app.mpr

# Check the project
mxcli docker check -p app.mpr
```

--------------------------------

### OpenCode Skill SKILL.md Example

Source: https://www.mxcli.org/tutorial/opencode.html

Example SKILL.md file with YAML frontmatter that OpenCode understands. Includes name, description, and compatibility fields.

```markdown
---
name: write-microflows
description: MDL syntax and patterns for creating microflows
compatibility: opencode
---

# Writing Microflows
...
```

--------------------------------

### Run local dev loop with watch and screenshot

Source: https://www.mxcli.org/tutorial/claude-code-web.html

Starts the warm local dev loop with hot-reload and a screenshot per change. Use this in a web session to get a Docker-free ~1-second edit-to-test cycle.

```bash
mxcli run --local -p App.mpr --watch --screenshot   # hot-reload + a PNG per change
```

--------------------------------

### mxcli init --sync-skills command

Source: https://www.mxcli.org/ide/syncing.html

Run this command to sync skills, lint rules, and project guidance with the binary. It is quiet when everything is already current.

```bash
mxcli init --sync-skills      # or: mxcli init --sync
```

--------------------------------

### Download mxbuild with mxcli setup

Source: https://www.mxcli.org/tools/devcontainer.html

Downloads the correct mxbuild version for the project to ~/.mxcli/mxbuild/{version}/ and makes the mx tool available for validation and project creation.

```bash
mxcli setup mxbuild -p app.mpr
```

--------------------------------

### Download mxbuild explicitly before running mx check

Source: https://www.mxcli.org/tools/docker-check.html

Use this command when mxbuild is not installed locally and you need to download it before running `mx check`. The comment notes that this is an explicit setup step that downloads the required mxbuild version.

```bash
# Explicit setup (downloads mxbuild)
mxcli docker check -p app.mpr

```

--------------------------------

### Custom rule example: EntityPrefix

Source: https://www.mxcli.org/tools/custom-rules.html

Defines a rule with metadata constants and a check() function that iterates over entities and reports violations when an entity name does not start with its module's first three letters. Uses builtins entities(), violation(), and location().

```starlark
# .claude/lint-rules/custom001_entity_prefix.star

RULE_ID = "CUSTOM001"
RULE_NAME = "EntityPrefix"
DESCRIPTION = "Entity names start with their module's abbreviation"
CATEGORY = "naming"
SEVERITY = "warning"            # error, warning, info or hint

def check():
    violations = []
    for entity in entities():
        prefix = entity.module_name[:3]
        if not entity.name.startswith(prefix):
            violations.append(violation(
                message = "Entity '%s' should start with '%s'" % (entity.name, prefix),
                location = location(
                    module = entity.module_name,
                    document_type = "entity",
                    document_name = entity.name,
                ),
                suggestion = "Rename to %s%s" % (prefix, entity.name),
            ))
    return violations

```

--------------------------------

### mxcli init tool selection

Source: https://www.mxcli.org/tutorial/installation.html

Shows how to target different AI tools with mxcli init. Use --tool to specify one or more tools, or --all-tools to configure everything. Run mxcli init --list-tools to see all supported tools.

```bash
# Cursor only
mxcli init --tool cursor /path/to/my-mendix-project

# Multiple tools
mxcli init --tool claude --tool cursor /path/to/my-mendix-project

# Everything
mxcli init --all-tools /path/to/my-mendix-project
```

--------------------------------

### MDL script with header and entity definition

Source: https://www.mxcli.org/language/basics.html

A minimal MDL script that starts with the `mdl 1;` header and defines a persistent entity `Sales.Customer` with a `Name` field of type `String(200)`. This is the canonical form used throughout the manual and example scripts.

```mdl
mdl 1;

create persistent entity Sales.Customer (
  Name: String(200)
);
```

--------------------------------

### Create task queue examples

Source: https://www.mxcli.org/language/scheduled-events.html

Shows the default parallelism and cluster-wide behavior, plus a custom expression. A bare integer and a quoted one mean the same thing; an arbitrary expression is legal.

```mdl
mdl 1;
CREATE TASK QUEUE Ops.OrderProcessing ( Parallelism: 3, ClusterWide: true );
CREATE TASK QUEUE Ops.Mail;                      -- defaults: 1, per-instance
CREATE OR MODIFY TASK QUEUE Ops.OrderProcessing ( Parallelism: '$MyModule.Workers' );

```

--------------------------------

### Set start event position with @start

Source: https://www.mxcli.org/language/microflow-structure.html

The start event has no statement of its own, so @start goes on the first statement — the one the start flows into. Positions are optional; a flow without them is laid out automatically.

```text
@start(145, 200)
@position(260, 200)
$Order = CREATE Sales.Order (Status = 'New');
```

--------------------------------

### Install bundled Chromium for playwright-cli

Source: https://www.mxcli.org/tools/playwright.html

Use this command to install the bundled Chromium and headless shell when provisioning outside mxcli init or debugging a browser-launch failure. It is required because playwright-cli install does not install a browser, and the default chrome channel has no Linux arm64 distribution.

```bash
node "$(npm root -g)/@playwright/cli/node_modules/playwright-core/cli.js" \
  install chromium chromium-headless-shell
```

--------------------------------

### Install theme switcher with mxcli

Source: https://www.mxcli.org/tools/theme.html

Installs the theme switcher module after applying the themes. The switcher generates nanoflows and actions built against the installed theme set.

```bash
mxcli theme apply signal ledger console -p app.mpr
mxcli theme switcher install -p app.mpr --module MyFirstModule
```

--------------------------------

### Directory structure for test files

Source: https://www.mxcli.org/tools/test-formats.html

Shows an example directory layout with .test.mdl and .test.md files. A directory run picks up every such file (not recursively) and reports them as one suite.

```text

__
tests/
├── domain-model.test.mdl
├── microflows.test.mdl
├── security.test.mdl
└── ordering.test.md

```

--------------------------------

### DESCRIBE SETTINGS CONFIGURATION example

Source: https://www.mxcli.org/reference/settings/list-describe-settings.html

Outputs only the CONFIGURATION category settings, such as DatabaseType, DatabaseUrl, and HttpPortNumber. Each named configuration is listed separately.

```mdl
DESCRIBE SETTINGS CONFIGURATION;
```

--------------------------------

### LIST IMPACT OF examples

Source: https://www.mxcli.org/tools/references-impact.html

Examples of using LIST IMPACT OF for different scenarios.

```mx
-- Analyze impact of changing an entity
LIST IMPACT OF Sales.Customer;

-- Analyze impact before removing a microflow
LIST IMPACT OF Sales.ACT_CalculateTotal;

-- Check impact before moving an element
LIST IMPACT OF Sales.CustomerOverview;
```

--------------------------------

### mxcli DESCRIBE STRUCTURE command examples

Source: https://www.mxcli.org/tutorial/describe-structure.html

Command-line examples for running DESCRIBE STRUCTURE with mxcli, showing different depth and module filters.

```bash
__
# Quick project overview
mxcli -p app.mpr -c "DESCRIBE STRUCTURE DEPTH 1"

# Detailed view of one module
mxcli -p app.mpr -c "DESCRIBE STRUCTURE DEPTH 3 IN Sales"

# Full project including system modules
mxcli -p app.mpr -c "DESCRIBE STRUCTURE ALL"
```

--------------------------------

### DESCRIBE CONTEXT Examples

Source: https://www.mxcli.org/tools/describe-context.html

Examples of DESCRIBE CONTEXT for a microflow, entity, and page.

```sql
__
-- Describe context of a microflow
DESCRIBE CONTEXT OF Sales.ACT_ProcessOrder;

-- Describe context of an entity
DESCRIBE CONTEXT OF Sales.Customer;

-- Describe context of a page
DESCRIBE CONTEXT OF Sales.CustomerOverview;

```

--------------------------------

### HashedString attribute example

Source: https://www.mxcli.org/language/primitive-types.html

Example HashedString attribute declaration for storing a password.

```mdl
Password: HashedString
```
Tokens:
Raw