Developer Resources · CLI
Command reference
Every Monime CLI command with its aliases, arguments and flags, plus the global flags that work on all of them.
Run monime <command> --help in your terminal for the same information, with examples.
Global flags
These flags work on every command.
| Flag | What it does |
|---|---|
--space ID | Operate in this Space (overrides core/space) |
--account ALIAS | Act as the Monimeer with this alias (overrides core/account) |
--configuration NAME | Use this configuration instead of the active one |
-q, --quiet | Turn off prompts and use default answers (overrides core/disable_prompts) |
--verbosity LEVEL | Minimum log level: debug, info, warning, error or none (overrides core/verbosity) |
-h, --help | Show help for a command |
-v, --version | Show the CLI version |
monime account
Log in as a Monimeer and manage your logins. Alias: auth. See Log in and choose a Space.
| Command | Aliases | Flags |
|---|---|---|
monime account login | monime login | --no-browser, --device-name NAME, --skip-space |
monime account list | ls | -o table|wide|json|yaml, --no-headers |
monime account logout [ALIAS...] | revoke | --all |
monime space
Choose and view the Spaces you work in. Alias: spaces.
| Command | Aliases | Flags |
|---|---|---|
monime space list | ls | -o table|wide|json|yaml, --no-headers |
monime space use [SPACE] | activate, switch | — |
monime status
Show the Monimeer commands act as, whether the login is still valid, and the Space they act in. Alias: whoami. Exits with a non-zero status when you are not logged in.
| Command | Flags |
|---|---|
monime status | -o json|yaml |
monime config
Manage CLI properties and named configurations. See Configuration.
| Command | Aliases | Flags |
|---|---|---|
monime config get PROPERTY | — | — |
monime config set PROPERTY VALUE | — | — |
monime config unset PROPERTY | — | — |
monime config list | ls | --all, -o table|wide|json|yaml, --no-headers |
monime config configurations manages named configurations. Alias: configs.
| Command | Aliases | Flags |
|---|---|---|
monime config configurations create NAME | — | — |
monime config configurations activate NAME | — | — |
monime config configurations list | ls | — |
monime config configurations describe [NAME] | — | — |
monime config configurations delete NAME... | — | — |
monime dot
Create, build, run and publish Dash Dots. Needs Node.js 22.12 or newer. See Dash Dots. Commands that act on a dot take --dot ID (default: the dot in the current folder), and commands that act in a Space take --space ID.
| Command | Flags |
|---|---|
monime dot create [DIR] | --name NAME, --template starter|showcase, --pm npm|pnpm|yarn|bun |
monime dot create page PATH | — |
monime dot dev [ROOT] | --port PORT, --device, --out-dir DIR, --conditions LIST |
monime dot preview [ROOT] | --port PORT, --out-dir DIR, --conditions LIST |
monime dot build [ROOT] | --out-dir DIR, --conditions LIST |
monime dot lsp | --stdio |
monime dot keys create | --label LABEL |
monime dot keys register | --label LABEL |
monime dot keys list | — |
monime dot keys revoke [KEY_ID] | — |
monime dot register [ROOT] | --space ID |
monime dot publish [ROOT] | --subtitle TEXT, --description TEXT, --wait, --out-dir DIR, --conditions LIST, --space ID |
monime dot version list | --state STATE (repeatable), --dot ID |
monime dot version describe VERSION | --dot ID |
monime dot release [VERSION] | --to everyone|testers, --dot ID |
monime dot switch-off [VERSION] | --note TEXT, --dot ID |
monime dot switch-on [VERSION] | --note TEXT, --dot ID |
monime dot tester list | --dot ID |
monime dot tester add DASHTAG | --dot ID |
monime dot tester remove DASHTAG | --dot ID |
monime dot list | --space ID |
monime dot describe | --dot ID |
monime dot doctor [ROOT] | --space ID |
monime dot install [VERSION] | — |
monime dot update | --check |
monime dot uninstall | — |
monime update
Update the CLI. Alias: upgrade. The download is checked against the release's checksums before the CLI is replaced.
| Command | Flags |
|---|---|
monime update | --check, --version VERSION |
monime version
| Command | Flags |
|---|---|
monime version | -o json|yaml |
monime completion
Generate a shell completion script. See Shell completion.
| Command |
|---|
monime completion bash |
monime completion zsh |
monime completion fish |
monime completion powershell |