Documentation Index Fetch the complete documentation index at: https://mintlify.com/mikronita/mikrom/llms.txt
Use this file to discover all available pages before exploring further.
The mikrom CLI is a Rust-built binary compiled from the mikrom-cli crate and powered by clap . It is the primary operator interface for the Mikrom edge platform, letting you manage applications, live deployments, databases, persistent volumes, projects, personal access tokens, and platform notifications entirely from a terminal. Every command is organized into a named subcommand group so you can discover available operations with --help at any level of the hierarchy.
Installation Install the mikrom binary from the workspace root using the install-cli Makefile target, which runs cargo install against the mikrom-cli crate and places the binary in ~/.cargo/bin:
Verify the installation succeeded and confirm the active version:
Shell Completions The mikrom completion subcommand generates shell completion scripts for your preferred shell. Pipe the output into the appropriate file for your environment.
# Bash — add to ~/.bash_completion.d or source directly mikrom completion bash > ~/.bash_completion.d/mikrom # Zsh mikrom completion zsh > "${ fpath [1]}/_mikrom" # Fish mikrom completion fish > ~/.config/fish/completions/mikrom.fish # PowerShell mikrom completion powershell | Out-String | Invoke-Expression
Supported shells come directly from clap_complete::Shellbash, zsh, fish, elvish, and powershell.
Global Options These flags are available on every command and subcommand:
Flag Short Description --output <format>-oOutput format: table (default) or json --verbose-vIncrease log verbosity; repeat for more detail (-v, -vv, -vvv) --no-color— Disable colored output (also honoured via NO_COLOR env var)
The --output json flag is useful for piping mikrom output into jq or other tooling. Not every command has machine-readable output, but all list and status commands support it.
Command Groups The CLI is structured around eleven top-level subcommand groups. Each group maps to a specific concern within the platform.
Command Description mikrom authAuthentication and profile management mikrom appApplication lifecycle management mikrom deploymentLive microVM instance management (jobs) mikrom configCLI configuration mikrom volumePersistent storage management mikrom dbDatabase management (Neon-backed) mikrom patPersonal Access Token management mikrom notificationPlatform notification management mikrom projectProject and tenant management mikrom systemSystem status and health mikrom completionGenerate shell completion scripts
mikrom authAuthenticate with the platform and manage your user profile.
Subcommand Description auth loginLogin with --email and --password auth registerRegister a new account auth whoamiDisplay the currently authenticated user profile auth updateUpdate profile details (--first-name, --last-name)
mikrom appCreate and manage applications. Each app is backed by a Git repository and deployed into microVMs.
Subcommand Description app listList all applications in the active project app createCreate a new app (--name, --git-url) app deleteDelete an application (--name, --yes to skip prompt) app deployTrigger a new deployment build (--name, --cpu, --memory, --hypervisor) app activateActivate or roll back to a specific deployment version app deploymentsList deployment history for an application app secretShow the GitHub webhook secret for an application app scaleConfigure fixed replicas or autoscaling thresholds
Resource options for app deploy:
--cpu: 1, 2, 3, or 4 cores (default: 1)--memory / -m: 512M, 1G, 2G, or 4G (default: 512M)--hypervisor / -H: firecracker, cloud-hypervisor, or unspecified
mikrom deploymentInteract with live deployment instances (referred to as jobs). Each job is a running microVM for an application version.
Subcommand Description deployment listList all active deployments across all apps deployment statusGet detailed status of a specific job (--app, --job-id) deployment stopStop and kill a running instance deployment pauseSuspend CPU for a running instance deployment resumeResume a paused instance deployment deleteRemove a deployment record from history deployment snapshotsList VM snapshots for a deployment deployment snapshot-createCreate a new VM snapshot deployment snapshot-restoreRestore a VM to a named snapshot deployment snapshot-deleteDelete a named VM snapshot
mikrom configRead and write CLI configuration. See the Configuration page for full details.
Subcommand Description config showDisplay the current configuration config set <key> <value>Set a configuration value
mikrom volumeManage persistent volumes that can be attached to application microVMs.
Subcommand Description volume listList volumes, optionally filtered by --app volume createCreate a new volume (--name, --size in MiB) volume attachAttach a volume to an app (--app, --volume-id, --mount, --mode) volume detachDetach a volume from an app volume snapshotCreate a snapshot of a volume volume restoreRestore a volume to a named snapshot volume snapshots listList snapshots for a volume volume snapshots deleteDelete a specific snapshot volume deletePermanently delete a volume
Access modes for volume attach --mode:
0 — ReadWriteOnce (RWO)1 — ReadWriteMany (RWX)2 — ReadOnlyMany (ROX)
mikrom dbProvision and manage Neon-backed PostgreSQL databases running in Cloud Hypervisor microVMs.
Subcommand Description db listList all databases in the active project db create <name>Create a database (engine, version, vCPUs, memory, disk) db delete <id>Delete a database db info <id>Show database details db connection <id>Show SSH tunnel and psql connection details db branches <id>List Neon branches for a database db backup <id>Show backup details db snapshots <id>List snapshots db snapshot-create <id> <name>Create a database snapshot db snapshot-restore <id> <snapshot>Restore to a named snapshot db snapshot-delete <id> <snapshot>Delete a named snapshot
Default values for db create: engine neon, PostgreSQL version 16, 1 vCPU, 512M RAM, 1024 MiB disk.
mikrom patCreate and manage Personal Access Tokens for use in automation and CI/CD pipelines.
Subcommand Description pat listList all PATs pat create <name>Create a new PAT with a descriptive name pat revoke <id>Revoke a PAT by ID (--yes to skip confirmation)
mikrom notificationManage platform notifications for your account.
Subcommand Description notification listList notifications (--unread-only, --limit, --offset) notification read <id>Mark a specific notification as read notification read-allMark all notifications as read
mikrom projectSwitch between projects (tenants) and list or create projects.
Subcommand Description project listList all projects you have access to project createCreate a new project (--name) project switch <tenant-id>Switch the CLI context to a different project (6-char slug)
mikrom systemInspect the health of platform services.
Subcommand Description system healthCheck the health of all system services
Quick Reference
Auth Login, register, and manage your user profile
App Create, deploy, scale, and delete applications
Deployment Inspect and control live microVM job instances
Database Provision and connect to Neon-backed PostgreSQL databases
Volume Manage persistent volumes and snapshots
Project Switch between project tenants and create new ones
PAT Create and revoke Personal Access Tokens
System Check platform service health