CLI overview

mikrom is the command-line client for the platform (crate mikrom-cli, binary mikrom).

Install and configure

See Installation. In short:

cargo install --path mikrom-cli          # or install the release .deb
mikrom config set api-url https://<your-mikrom-api-host>
mikrom auth login --email <you@example.com> --password '<password>'

Command groups

Group	Purpose
auth	Log in / register, view and update your profile
app	Create, deploy, scale, roll back, and inspect apps
deployment	Operate individual live instances (jobs)
db	PostgreSQL databases (Neon): create, connect, branch, back up, snapshot
volume	Persistent volumes and volume snapshots
pat	Personal access tokens
notification	Platform notifications
project	Projects and CLI project context
config	CLI configuration
system	Platform health
completion	Generate shell completion scripts

Full details in the CLI reference.

Global options

Available on every command:

Option	Meaning
-o, --output <table|json>	Output format (default table). Use json for scripting.
-v, -vv, -vvv	Increase log verbosity
--no-color	Disable colored output (also honours NO_COLOR)
-V, --version	Print version
-h, --help	Help for any command or subcommand

Configuration

Stored at ~/.config/mikrom/config.toml (override with MIKROM_CONFIG_PATH).

mikrom config show
mikrom config set api-url https://api.example.com
mikrom config set active-project <slug>

Environment variables take precedence over the file:

Variable	Overrides
MIKROM_API_URL	api-url
MIKROM_TOKEN	stored access token / PAT
MIKROM_REFRESH_TOKEN	stored refresh token
MIKROM_ACTIVE_TENANT_ID	active-project
MIKROM_REQUEST_TIMEOUT_SECS	default request timeout
MIKROM_DELETE_TIMEOUT_SECS	delete-operation timeout
MIKROM_RESTORE_TIMEOUT_SECS	restore-operation timeout
MIKROM_LONG_TIMEOUT_SECS	long-operation timeout

Scripting

Use --output json and a PAT:

export MIKROM_TOKEN=mikrom_pat_xxxxxxxxxxxxxxxx
mikrom app deployments --name my-app --output json | jq '.[0].id'

Shell completions

mikrom completion bash > /etc/bash_completion.d/mikrom
mikrom completion zsh  > ~/.zfunc/_mikrom
# also: fish | elvish | powershell