Commands
Commands
jcm --help and jcm <command> --help print each command's options. jcm --version prints the launcher's version
(even when Docker is not running) and the tools image's.
jcm new
jcm new <name> [--template blank|hearings|permits] [--package p] [--title t] [--dir d] [--ide intellij|eclipse|vscode] [--features list] creates an application from
a template, in a new folder that is a new Git repository with nothing committed. blank is the default: one case type,
Request. hearings holds the hearings demo's configuration and model files, moved to your package. permits is a
case type PermitApplication with a three-state workflow, a queue, a letter, a dashboard, a job role, seed data, a
workflow test and a browser test, which jcm check --browser runs. Each template's application passes its own
jcm check.
Choose --ide intellij, --ide eclipse or --ide vscode to add opening instructions to the generated README.
The editor needs JDK 21 locally; the command still needs only Docker. All three open the same Gradle project and
use jcm check. No editor is selected by default, and no personal editor settings are written.
--features takes a nonempty comma-separated list of queues, workflows, clocks, letters, hearings,
slots, mailbox and reports. It uses the scaffold's dependency rules; hearings and slots select the calendar
component. The blank template starts with the generated case screen and its dependencies; other templates retain
their required components. The command and generated README show the requested features and installed starters.
Omitting a feature does not remove a component the screen or sample requires. Omitting the option preserves the
template's defaults. It connects no external service.
The project file
The project file is jcm-project.yml, flat keys name, jcm-version, template, control-plane,
project, environment; any other key is refused with its line. Never jcm.yml (the app-wide settings file).
No secret in it.
jcm run
jcm run [--port] [--mail-port] [--listen] [--stop] [--reset [--yes]] builds the application and runs it on this
machine, with PostgreSQL 16 and a mail catcher (Mailpit) beside it, each in a container. The address is printed once the
application's readiness check answers. Run it again after a change: it builds and replaces the running application and
keeps the database. --stop stops it and keeps the database; --reset also drops the database, asking first unless
--yes. Every port is on 127.0.0.1 unless --listen says otherwise.
It prints no password. jcm new writes a Running with jcm section in the application's README naming the template's
local test users (admin/admin, and the seeded ones). Seeded users' password is drawn once and kept in
.jcm/local.env, which only you can read.
jcm check
jcm check [--db postgres] [--browser] [--skip-startup] runs four stages and prints one line for each:
- startup: the application on an in-memory database until it is ready; a configuration file it refuses is shown in full with its file and line.
- tests: the application's tests, with its browser tests in the image's Chromium under
--browser, and on PostgreSQL under--db postgres. - extension API: project Java uses only the supported extension API.
- Jmix layer: the build declares JCM starters and the Jmix platform only.
Each stage's log is in build/jcm-check/. The exit code is not zero when a stage fails.
jcm changelog
jcm changelog [--baseline] runs the project's jcmChangelog task in the tools image, with no socket, token or config
folder, so a model change needs only Docker. Gradle's output is on the screen and in build/jcm-changelog.log; the
exit code is not zero when the task refuses the model. checkJcmModel's refusals name it beside ./gradlew jcmChangelog.