Jmix CLI

Create Jmix projects from the same templates as Jmix Studio.

Use the interactive wizard or run the CLI from a script or an AI agent.

Install

macOS / Linux

curl -fsSL https://github.com/jmix-framework/jmix-cli/releases/latest/download/install.sh | bash

Windows (PowerShell)

irm https://github.com/jmix-framework/jmix-cli/releases/latest/download/install.ps1 | iex

The installer opens the command menu. On macOS and Linux, open a new terminal after installation so your shell can find jmix. See the distribution guide for other installation options.

Create a project

Run jmix to open the command menu or jmix new to go straight to the wizard. Choose a template, languages, and add-ons. From a script, generate a project with --non-interactive.

jmix new demo --non-interactive
cd demo
./gradlew bootRun

On Windows, use .\gradlew.bat bootRun. The CLI bundles Java, but building the generated app requires a compatible JDK. The wizard can help install one.

Run jmix new --help for options such as --jmix-version, --template, and --addons. See wizard controls, project generation, and commercial add-on setup.

Agent Toolkit

New projects include Agent Toolkit guidelines and skills. The Toolkit configures JetBrains and Playwright MCP servers for Codex, Claude Code, and OpenCode. Use --no-agents-toolkit to skip setup. See the Agent Toolkit guide.

Jmix account and trial

Sign in to download the Enterprise+BPM trial project.

jmix login
jmix trial

Use jmix login --region ru for a jmix.ru account. See the account and trial guide for activation and scripting options.

Update

Installed builds check for updates automatically. Run jmix update to update on demand. See the update guide.

Development

Use JDK 17 or newer to launch Gradle. The build provisions a JDK 25 toolchain.

./run.sh        # Run from source on macOS or Linux
./gradlew build # Build and test

See the contributor guide for verification and feature docs.

License

Apache License 2.0.