Skip to content

Commit 6f9ae10

Browse files
akoclaude
andcommitted
docs: add mxcli playground links to README and docs site
Add "Try it in the Playground" link to the main README header and a new "Playground (zero install)" section as the first installation option in the mdbook tutorial docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b6f7c6f commit 6f9ae10

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
A command-line tool that enables AI coding assistants ([Claude Code](https://claude.ai/claude-code), Cursor, Continue.dev, Windsurf, Aider, and others) to read, understand, and modify Mendix application projects.
66

7-
**[Read the documentation](https://mendixlabs.github.io/mxcli/)**
7+
**[Read the documentation](https://mendixlabs.github.io/mxcli/)** | **[Try it in the Playground](https://codespaces.new/mendixlabs/mxcli-playground)** -- no install needed, runs in your browser
88

99
## Why mxcli?
1010

docs-site/src/tutorial/installation.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# Installation
22

3-
Pick whichever method suits your situation. If you're planning to use mxcli with an AI coding assistant, skip ahead to the [Dev Container](#dev-container-recommended) section -- it's the smoothest experience.
3+
Pick whichever method suits your situation. If you just want to try mxcli without installing anything, start with the [Playground](#playground-zero-install). If you're planning to use mxcli on your own project with an AI coding assistant, skip to the [Dev Container](#dev-container-recommended) section.
4+
5+
## Playground (zero install)
6+
7+
The fastest way to try mxcli. The [mxcli Playground](https://github.com/mendixlabs/mxcli-playground) is a GitHub repository with a pre-configured Mendix project, example scripts, and tutorials. Open it in a Codespace and start using mxcli immediately -- nothing to install on your machine.
8+
9+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/mendixlabs/mxcli-playground)
10+
11+
The Codespace comes with mxcli, a JDK, Docker-in-Docker, Claude Code, and a sample Mendix 11.x project ready to explore and modify. It includes:
12+
13+
- **5 example scripts** -- explore, create entities, microflows, pages, and security
14+
- **Step-by-step tutorials** -- from first steps through linting and testing
15+
- **AI tool configs** -- pre-configured for Claude Code, Cursor, Windsurf, Continue.dev, and Aider
16+
17+
Once the Codespace is running:
18+
19+
```bash
20+
./mxcli -p App.mpr -c "SHOW STRUCTURE" # Explore the project
21+
./mxcli exec scripts/01-explore.mdl -p App.mpr # Run an example script
22+
./mxcli # Start interactive REPL
23+
```
24+
25+
When you're ready to work on your own Mendix project, use one of the installation methods below.
426

527
## Binary download
628

docs-site/src/tutorial/setup.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ This chapter walks you through all three.
1010

1111
## Installation methods
1212

13-
There are three ways to get mxcli running:
13+
There are four ways to get started with mxcli:
1414

15-
- **Binary download** -- grab a pre-built binary from GitHub Releases. Quickest path if you just want to try it out.
15+
- **[Playground](installation.md#playground-zero-install)** -- open the [mxcli Playground](https://github.com/mendixlabs/mxcli-playground) in a GitHub Codespace. Zero install, runs in your browser with a sample Mendix project, tutorials, and example scripts. Best way to try mxcli for the first time.
16+
- **Binary download** -- grab a pre-built binary from GitHub Releases. Quickest path if you want to use mxcli on your own project.
1617
- **Build from source** -- clone the repo and run `make build`. Useful if you want the latest unreleased changes or plan to contribute.
17-
- **Dev Container** (recommended) -- run `mxcli init` on your Mendix project, open it in VS Code, and reopen in the container. This gives you mxcli, a JDK, Docker-in-Docker, and Claude Code all pre-configured in a sandboxed environment. This is the recommended approach, especially when pairing with AI coding assistants.
18+
- **Dev Container** (recommended for your own projects) -- run `mxcli init` on your Mendix project, open it in VS Code, and reopen in the container. This gives you mxcli, a JDK, Docker-in-Docker, and Claude Code all pre-configured in a sandboxed environment. This is the recommended approach, especially when pairing with AI coding assistants.
1819

1920
The next few pages cover each method, then walk you through opening a project and using the REPL.
2021

0 commit comments

Comments
 (0)