mxcli CLAUDE.md

CLAUDE.md

This file provides guidance for Claude Code when working with this repository.

Welcome — Contributing to mxcli

If you're starting a new task, here's how contributions work in this repo:

1. File an issue first — describe the bug or feature before coding. See CONTRIBUTING.md for details.
2. Get approval — wait for maintainer sign-off before starting work.
3. Create a feature branch — feature/123-short-description or fix/456-what-broke.
4. Use the contributor commands to stay on track:
   • /mxcli-dev:proposal — create a structured feature proposal (asks the right questions, investigates BSON storage)
   • /mxcli-dev:review — review your changes against the PR checklist before pushing
5. Validate locally — make build && make test && make lint must all pass.
6. Open a PR — link the issue, document Mendix Studio Pro validation, confirm agentic testing.

For the full workflow, read CONTRIBUTING.md. For the review checklist applied to every PR, see the "PR / Commit Review Checklist" section below.

Project Overview

ModelSDK Go is a Go library for reading and modifying Mendix application projects (.mpr files) stored locally on disk. It's a Go-native alternative to the TypeScript-based Mendix Model SDK, enabling programmatic access without cloud connectivity.

Build & Test Commands

# build the CLI (preferred - uses Makefile)
make build

# run tests
make test

# format and vet code
make fmt
make vet

# run a specific example
go run ./examples/read_project/main.go /path/to/project.mpr
go run ./examples/modify_project/main.go /path/to/project.mpr

# run the code generator
go run ./cmd/codegen/main.go -reflection-dir ./reference/mendixmodellib/reflection-data -version 10.0.0 -output ./generated/metamodel

Note: This project uses modernc.org/sqlite (pure Go) and does not require CGO. No C compiler is needed.

Note: The VS Code extension (vscode-mdl/) uses bun, not npm/node. Use bun install, bun run compile, etc. The Makefile targets (make vscode-ext, make vscode-install) already use bun.