Installation

The mikrom CLI is the primary way to operate the platform. It is a single static-ish binary named mikrom (crate mikrom-cli).

Install

From a release package

Tagged releases publish Debian packages as GitHub release assets. On a Debian/Ubuntu host:

# download mikrom-cli_<version>_<arch>.deb from the Releases page, then:
sudo apt install ./mikrom-cli_<version>_<arch>.deb

This installs mikrom to /usr/bin/mikrom.

From source

Requires a stable Rust toolchain and protoc.

git clone https://github.com/spluca/mikrom.git
cd mikrom
make install-cli        # runs: cargo install --path mikrom-cli  → ~/.cargo/bin/mikrom

Or without the checkout layout:

cargo install --path mikrom-cli

Shell completions

mikrom completion zsh  > ~/.zfunc/_mikrom      # or bash | fish | elvish | powershell

Point the CLI at your platform

The CLI talks to a mikrom-api instance. The default is http://localhost:5001; set your platform’s URL once:

mikrom config set api-url https://<your-mikrom-api-host>

Configuration is stored at ~/.config/mikrom/config.toml (override the path with MIKROM_CONFIG_PATH). The keys you can set are:

Key	Meaning
api-url	Base URL of the control-plane API
active-project	Project slug used for project-scoped commands

Environment variables override the file: MIKROM_API_URL, MIKROM_TOKEN, MIKROM_REFRESH_TOKEN, MIKROM_ACTIVE_TENANT_ID, and the timeout knobs MIKROM_REQUEST_TIMEOUT_SECS, MIKROM_DELETE_TIMEOUT_SECS, MIKROM_RESTORE_TIMEOUT_SECS, MIKROM_LONG_TIMEOUT_SECS.

Verify

mikrom config show
mikrom system health          # checks the platform services

mikrom system health reports the health of the control-plane services. If it cannot reach the API, re-check api-url and your network path to the host.

Authenticate

mikrom auth login --email <you@example.com> --password '<password>'
mikrom auth whoami

login stores an access token and a refresh token in the config file; the CLI refreshes the access token automatically. See Authentication for tokens, PATs, and 2FA.

Next steps

• Quickstart: deploy your first app