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
docs: sweep install guidance — correct asset format, go install, recommend nightly
Swept all user-facing docs for install accuracy. Two real inaccuracies fixed
beyond the go-install issue:
- Release assets are RAW binaries named mxcli-<os>-<arch> (not mxcli_<os>_<arch>.
tar.gz archives). quickstart.md and installation.md told users to download and
`tar xzf` a .tar.gz that doesn't exist — replaced with a direct curl of the raw
binary + chmod +x.
- `go install …@latest` was listed as "build from source"/an install option in
quickstart.md and installation.md; it fails (uncommitted generated parser).
Replaced with `git clone && make build`, plus a caveat note.
Also: recommend the rolling `nightly` build across README/quickstart/installation
while mxcli is fast-moving alpha (features land there before a tagged release),
with vX.Y.Z pinning for reproducibility. Flagged the go-install reality in the
warm-loop proposal's release row (it claimed a public Go module suffices).
Files: README.md, docs-site/src/tutorial/{quickstart,installation}.md,
docs-site/src/tools/bootstrap-prompt.md (earlier), PROPOSAL_mxcli_dev_warm_loop.md.
Docs-only.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JXnEgoc2NQP1Y2TWMCMXC4
Copy file name to clipboardExpand all lines: README.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -180,7 +180,16 @@ mxcli add-tool cursor
180
180
181
181
## Installation
182
182
183
-
Download the latest release for your platform from the [releases page](https://github.com/mendixlabs/mxcli/releases), or build from source:
183
+
Download a pre-built binary from the [releases page](https://github.com/mendixlabs/mxcli/releases) — the assets are raw binaries named `mxcli-<os>-<arch>` (nothing to extract). While mxcli is fast-moving alpha, the rolling `nightly` build is recommended (new features land there first); pin a `vX.Y.Z` release for reproducibility:
Or build from source (Go + Make — `make build` runs the ANTLR parser generation that `go install` can't):
184
193
185
194
```bash
186
195
git clone https://github.com/mendixlabs/mxcli.git
@@ -189,6 +198,8 @@ make build
189
198
# binary is at ./bin/mxcli
190
199
```
191
200
201
+
> `go install …@latest` is not supported: the generated ANTLR parser isn't committed, so a module-source build fails. Use a pre-built binary or `make build`.
Copy file name to clipboardExpand all lines: docs-site/src/tutorial/installation.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,19 +26,25 @@ When you're ready to work on your own Mendix project, use one of the installatio
26
26
27
27
## Binary download
28
28
29
-
Pre-built binaries are available for Linux, macOS, and Windows on both amd64 and arm64 architectures.
29
+
Pre-built binaries are published for Linux, macOS, and Windows on both amd64 and arm64. Release assets are **raw binaries** named `mxcli-<os>-<arch>` (Windows: `.exe`) — there is nothing to extract.
30
30
31
-
1. Go to the [GitHub Releases page](https://github.com/mendixlabs/mxcli/releases).
32
-
2. Download the archive for your platform (e.g., `mxcli_linux_amd64.tar.gz` or `mxcli_darwin_arm64.tar.gz`).
33
-
3. Extract the binary and move it somewhere on your `PATH`:
31
+
While mxcli is fast-moving alpha, use the rolling **`nightly`** build (new features land there before a tagged release); pin a `vX.Y.Z` release for reproducibility.
On Windows, extract the `.zip` and add the folder containing `mxcli.exe` to your system PATH.
45
+
Assets: `mxcli-linux-amd64`, `mxcli-linux-arm64`, `mxcli-darwin-amd64`, `mxcli-darwin-arm64`, `mxcli-windows-amd64.exe`, `mxcli-windows-arm64.exe`. On Windows, download the `.exe` and add its folder to your PATH. You can browse them on the [GitHub Releases page](https://github.com/mendixlabs/mxcli/releases).
46
+
47
+
> `go install github.com/mendixlabs/mxcli/cmd/mxcli@latest` does **not** work: the ANTLR parser is generated at build time and isn't committed, so a `go install` from the module source fails. Use a pre-built binary, or **Build from source** below (which runs `make grammar`).
go install github.com/mendixlabs/mxcli/cmd/mxcli@latest
27
+
git clone https://github.com/mendixlabs/mxcli.git &&cd mxcli && make build
28
+
# binary at ./bin/mxcli (go install @latest doesn't work — see Installation)
27
29
```
28
30
29
31
Verify: `mxcli --version` should print the version number.
@@ -132,6 +134,6 @@ No errors? You're done. Open in Studio Pro and everything is there.
132
134
mxcli setup mxbuild -p your-app.mpr
133
135
```
134
136
135
-
**"CGO not available"** -- mxcli uses pure Go SQLite. No C compiler needed. If you see CGO errors, ensure you're using the official binary or `go install`.
137
+
**"CGO not available"** -- mxcli uses pure Go SQLite. No C compiler needed. If you see CGO errors, ensure you're using the official pre-built binary or a `make build` from source.
136
138
137
139
**Project won't open in Studio Pro after changes** -- Close Studio Pro before running mxcli write commands, then reopen. See [F4 sync support](../appendixes/version-compatibility.md) for details.
Copy file name to clipboardExpand all lines: docs/11-proposals/PROPOSAL_mxcli_dev_warm_loop.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -501,7 +501,7 @@ downloads/caches mxbuild + runtime and speaks the M2EE admin API.
501
501
|`cmd/mxcli/init.go`| Emit a **SessionStart hook** (Claude Code Web) and/or devcontainer `postStart` that runs `mxcli dev up`; keep the existing devcontainer + `.claude/` scaffolding. |
502
502
|`cmd/mxcli/new.go`| Add `--emit-template`: write a GitHub-template-ready repo (config + starter `.mpr`), for CI-per-version publishing of `mendix-mxcli-starter`. |
503
503
|`docs-site/.../bootstrap-prompt.md`| Ship the canonical **prompt template** (the web/iPad seed prompt) as documented, copy-pasteable text. |
504
-
| release / go.mod | Ensure mxcli is deliverable into a gated web session — **public Go module** (`go install`) and/or an **environment setup-script**that pre-installs it; do not rely on a GitHub release `curl` (may be gate-blocked). |
504
+
| release / go.mod | Ensure mxcli is deliverable into a gated web session. **Status:** the module is public (tags to v0.16.0) but **`go install` does not build** — the generated ANTLR parser (`mdl/grammar/parser/`) is gitignored/uncommitted, so the tagged source is missing the package. Working paths today: prebuilt release binaries (`mxcli-<os>-<arch>`, incl. a rolling `nightly`) via `mxcli setup mxcli` / direct download, or an **environment setup-script** pre-install. Enabling `go install` needs the parser committed (or generated during module build) — open decision. |
0 commit comments