CLI reference
Generated from mikrom <command> --help. The global options
(-o/--output, -v, --no-color, -h) apply everywhere and are not repeated
below.
mikrom [OPTIONS] <COMMAND>Authentication and profile.
auth login
Section titled “auth login”mikrom auth login --email <EMAIL> --password <PASSWORD>
Log in and store the session tokens.
auth register
Section titled “auth register”mikrom auth register --email <EMAIL> --password <PASSWORD>
Register a new account.
auth whoami
Section titled “auth whoami”mikrom auth whoami
Display the current user profile.
auth update
Section titled “auth update”mikrom auth update [--first-name <FIRST_NAME>] [--last-name <LAST_NAME>]
Update profile details.
Application management.
app list
Section titled “app list”mikrom app list
List all applications.
app create
Section titled “app create”mikrom app create --name <NAME> --git-url <GIT_URL>
Create a new application. Assigns the hostname <name-slug>.<apps-domain>.
app delete
Section titled “app delete”mikrom app delete --name <NAME> [--yes]
Delete an application. --yes skips the confirmation prompt.
app deploy
Section titled “app deploy”mikrom app deploy --name <NAME> [--cpu <1|2|3|4>] [--memory <512M|1G|2G|4G>] [--hypervisor <firecracker|cloud-hypervisor>] [--watch]
Build and deploy a new version. --cpu default 1, --memory default 512M.
--watch streams progress until completion.
app activate
Section titled “app activate”mikrom app activate --app <APP> --deployment-id <DEPLOYMENT_ID>
Activate (or roll back to) a specific deployment.
app deployments
Section titled “app deployments”mikrom app deployments --name <NAME>
List deployment history for an application.
app secret
Section titled “app secret”mikrom app secret --name <NAME>
Show the GitHub webhook secret for an application.
app scale
Section titled “app scale”mikrom app scale --name <NAME> [--replicas <0-3>] [--auto <true|false>] [--min <0-3>] [--max <1-3>] [--cpu <PCT>] [--mem <PCT>]
Configure scaling. --replicas sets fixed replicas and disables autoscaling.
--auto toggles autoscaling; --min/--max bound it; --cpu/--mem are the
threshold percentages. All apps also scale to zero automatically after
inactivity.
app logs
Section titled “app logs”mikrom app logs --name <NAME> [--follow]
Stream real-time logs for an application.
deployment
Section titled “deployment”Live instance management (jobs). Every subcommand targets one job with
--app <APP> --job-id <JOB_ID>.
deployment list
Section titled “deployment list”mikrom deployment list
List all active deployments across all apps.
deployment status
Section titled “deployment status”mikrom deployment status --app <APP> --job-id <JOB_ID>
Detailed status of a live job.
deployment logs
Section titled “deployment logs”mikrom deployment logs --app <APP> --job-id <JOB_ID>
Stream a specific job’s logs.
deployment stop
Section titled “deployment stop”mikrom deployment stop --app <APP> --job-id <JOB_ID>
Stop a running deployment (kills the instance).
deployment pause
Section titled “deployment pause”mikrom deployment pause --app <APP> --job-id <JOB_ID>
Suspend the microVM’s CPU.
deployment resume
Section titled “deployment resume”mikrom deployment resume --app <APP> --job-id <JOB_ID>
Resume a paused deployment.
deployment delete
Section titled “deployment delete”mikrom deployment delete --app <APP> --job-id <JOB_ID> [--yes]
Remove a deployment record from history.
deployment snapshots
Section titled “deployment snapshots”mikrom deployment snapshots --app <APP> --job-id <JOB_ID>
List snapshots for a deployment microVM.
deployment snapshot-create
Section titled “deployment snapshot-create”mikrom deployment snapshot-create --app <APP> --job-id <JOB_ID> <NAME>
Create a snapshot of the deployment microVM.
deployment snapshot-restore
Section titled “deployment snapshot-restore”mikrom deployment snapshot-restore --app <APP> --job-id <JOB_ID> <SNAPSHOT>
Restore the microVM to a snapshot.
deployment snapshot-delete
Section titled “deployment snapshot-delete”mikrom deployment snapshot-delete --app <APP> --job-id <JOB_ID> <SNAPSHOT>
Delete a deployment microVM snapshot.
Database management (Neon). New databases default to PostgreSQL 16. <ID>
accepts a database name or id.
db list
Section titled “db list”mikrom db list
db create
Section titled “db create”mikrom db create <NAME>
Create a database.
db delete
Section titled “db delete”mikrom db delete <ID>
db info
Section titled “db info”mikrom db info <ID>
db connection
Section titled “db connection”mikrom db connection <ID>
Print connection details: an SSH tunnel command, a psql command through the
tunnel, and (--output json) the same metadata as JSON.
db branches
Section titled “db branches”mikrom db branches <ID>
db backup
Section titled “db backup”mikrom db backup <ID>
Show backup details.
db snapshots
Section titled “db snapshots”mikrom db snapshots <ID>
db snapshot-create
Section titled “db snapshot-create”mikrom db snapshot-create <ID> <NAME>
db snapshot-restore
Section titled “db snapshot-restore”mikrom db snapshot-restore <ID> <SNAPSHOT>
db snapshot-delete
Section titled “db snapshot-delete”mikrom db snapshot-delete <ID> <SNAPSHOT>
volume
Section titled “volume”Persistent storage.
volume list
Section titled “volume list”mikrom volume list [--app <APP>]
volume create
Section titled “volume create”mikrom volume create --name <NAME> --size <SIZE>
--size is in MiB.
volume attach
Section titled “volume attach”mikrom volume attach --app <APP> --volume-id <VOLUME_ID> --mount <MOUNT> [--mode <0|1|2>]
--mount is the path inside the microVM. --mode: 0 RWO (default), 1 RWX,
2 ROX.
volume detach
Section titled “volume detach”mikrom volume detach --app <APP> --volume-id <VOLUME_ID>
volume snapshot
Section titled “volume snapshot”mikrom volume snapshot --volume-id <VOLUME_ID> --name <NAME>
Create a volume snapshot.
volume restore
Section titled “volume restore”mikrom volume restore --volume-id <VOLUME_ID> --snapshot <SNAPSHOT>
volume snapshots list
Section titled “volume snapshots list”mikrom volume snapshots list --volume-id <VOLUME_ID>
volume snapshots delete
Section titled “volume snapshots delete”mikrom volume snapshots delete --snapshot-id <SNAPSHOT_ID> [--yes]
volume delete
Section titled “volume delete”mikrom volume delete --volume-id <VOLUME_ID> [--yes]
Personal access tokens.
pat list
Section titled “pat list”mikrom pat list
pat create
Section titled “pat create”mikrom pat create <NAME>
Prints the token value once.
pat revoke
Section titled “pat revoke”mikrom pat revoke <ID> [--yes]
notification
Section titled “notification”Platform notifications.
notification list
Section titled “notification list”mikrom notification list [--unread-only] [--limit <LIMIT>] [--offset <OFFSET>]
notification read
Section titled “notification read”mikrom notification read <ID>
notification read-all
Section titled “notification read-all”mikrom notification read-all
project
Section titled “project”Project management.
project list
Section titled “project list”mikrom project list
project create
Section titled “project create”mikrom project create --name <NAME>
project switch
Section titled “project switch”mikrom project switch <SLUG>
<SLUG> is the 6-char project slug from mikrom project list.
config
Section titled “config”CLI configuration.
config show
Section titled “config show”mikrom config show
config set
Section titled “config set”mikrom config set <KEY> <VALUE>
Keys: api-url, active-project.
system
Section titled “system”system health
Section titled “system health”mikrom system health
Check the health of all platform services.
completion
Section titled “completion”mikrom completion <bash|elvish|fish|powershell|zsh>
Print a shell completion script to stdout.