Commands

Complete reference for all miren CLI commands.

addon

Command	Description
`miren addon`	Addon management commands
`miren addon create`	Attach an addon to an application (`addons`)
`miren addon destroy`	Remove an addon from an application (`addons`)
`miren addon list`	List addons attached to an application (`addons`)
`miren addon list-available`	List available addons (`addons`)
`miren addon variants`	Show variants for an addon (`addons`)

admin

Command	Description
`miren admin`	Call an admin method on an application

alias

Command	Description
`miren alias`
`miren alias list`	List configured CLI aliases

app

Command	Description
`miren app`	Get information about an application
`miren app delete`	Delete an application and all its resources
`miren app history`	Show deployment history for an application
`miren app list`	List all applications
`miren app restart`	Restart an application
`miren app run`	Open interactive shell in a new sandbox
`miren app status`	Show current status of an application

apps

Command	Description
`miren apps`	List all applications (alias for 'app list')

auth

Command	Description
`miren auth`	Authentication commands
`miren auth ci`	CI authentication binding management
`miren auth ci add`	Add a CI authentication binding to an application
`miren auth ci list`	List CI authentication bindings for an application
`miren auth ci remove`	Remove a CI authentication binding
`miren auth generate`	Generate authentication config file

cluster

Command	Description
`miren cluster`	List configured clusters
`miren cluster add`	Add a new cluster configuration
`miren cluster current`	Show the pinned cluster for this app
`miren cluster export-address`	Export cluster address with TLS fingerprint for MIREN_CLUSTER
`miren cluster list`	List all configured clusters
`miren cluster remove`	Remove a cluster from the configuration
`miren cluster switch`	Switch to a different cluster

config

Command	Description
`miren config`	Configuration file management
`miren config info`	Show configuration file locations and format
`miren config load`	Load config and merge it with your current config

deploy

Command	Description
`miren deploy`	Deploy an application
`miren deploy cancel`	Cancel an in-progress deployment

disk

Command	Description
`miren disk`
`miren disk backup`	Backup a disk to a snapshot file
`miren disk list-deleted`	List deleted disks available for recovery
`miren disk restore`	Restore a disk from a snapshot file
`miren disk undelete`	Restore a recently deleted disk

doctor

Command	Description
`miren doctor`	Diagnose miren environment and connectivity
`miren doctor auth`	Check authentication and user information
`miren doctor config`	Check configuration files
`miren doctor server`	Check server health and connectivity

download

Command	Description
`miren download`	Download management commands
`miren download release`	Download and extract miren release

env

Command	Description
`miren env`	Environment variable management commands
`miren env delete`	Delete environment variables
`miren env get`	Get an environment variable value
`miren env list`	List all environment variables
`miren env set`	Set environment variables for an application

help

Command	Description
`miren help`	Show help for one or more commands
`miren help alias`	Learn how to define and use CLI aliases

init

Command	Description
`miren init`	Initialize a new application

Command	Description
`miren login`	Authenticate with miren.cloud

logout

Command	Description
`miren logout`	Remove local authentication credentials

logs

Command	Description
`miren logs`	View logs (defaults to app logs)
`miren logs app`	View application logs
`miren logs build`	View build logs
`miren logs sandbox`	View sandbox logs
`miren logs system`	View system logs

rollback

Command	Description
`miren rollback`	Roll back to a previous version

route

Command	Description
`miren route`	List all HTTP routes
`miren route list`	List all HTTP routes
`miren route oidc`	OIDC authentication management for routes
`miren route oidc disable`	Disable OIDC authentication for a route (`routeoidc`)
`miren route oidc enable`	Enable OIDC authentication for a route (`routeoidc`)
`miren route oidc show`	Show OIDC configuration for a route (`routeoidc`)
`miren route remove`	Remove an HTTP route
`miren route set`	Create or update an HTTP route
`miren route set-default`	Set an app as the default route
`miren route show`	Show details of an HTTP route
`miren route unset-default`	Remove the default route

runner

Command	Description
`miren runner`	Runner management commands
`miren runner install`	Install systemd service for miren runner (`distributedrunners`)
`miren runner join`	Join this machine to a coordinator as a runner (`distributedrunners`)
`miren runner list`	List all registered runners (`distributedrunners`)
`miren runner remove`	Remove a registered runner and clean up resources (`distributedrunners`)
`miren runner service-status`	Show miren-runner systemd service status (`distributedrunners`)
`miren runner start`	Start this machine as a distributed runner (`distributedrunners`)
`miren runner status`	Show runner health and configuration (`distributedrunners`)
`miren runner token`	Manage join tokens
`miren runner token create`	Create a join token for a runner (`distributedrunners`)
`miren runner token list`	List all join tokens (`distributedrunners`)
`miren runner token revoke`	Revoke a join token (`distributedrunners`)
`miren runner uninstall`	Remove systemd service for miren runner (`distributedrunners`)
`miren runner upgrade`	Upgrade miren runner to the latest or specified version (`distributedrunners`)
`miren runner upgrade rollback`	Rollback runner to previous version (`distributedrunners`)

sandbox

Command	Description
`miren sandbox`	Sandbox management commands
`miren sandbox delete`	Delete a dead sandbox
`miren sandbox exec`	Open interactive shell in an existing sandbox
`miren sandbox list`	List sandboxes (excludes dead by default)
`miren sandbox stop`	Stop a sandbox

sandbox-pool

Command	Description
`miren sandbox-pool`	Sandbox pool management commands
`miren sandbox-pool list`	List all sandbox pools
`miren sandbox-pool set-desired`	Set desired instance count for a sandbox pool

server

Command	Description
`miren server`	Start the miren server
`miren server config`	Server configuration management commands
`miren server config generate`	Generate a server configuration file from current settings
`miren server config validate`	Validate a server configuration file
`miren server docker`	Docker-based server management commands
`miren server docker install`	Install miren server using Docker
`miren server docker status`	Show status of miren server Docker container
`miren server docker uninstall`	Uninstall miren server Docker container
`miren server install`	Install systemd service for miren server
`miren server register`	Register this cluster with miren.cloud
`miren server register status`	Show cluster registration status
`miren server status`	Show miren service status
`miren server uninstall`	Remove systemd service for miren server
`miren server upgrade`	Upgrade miren server
`miren server upgrade rollback`	Rollback server to previous version

upgrade

Command	Description
`miren upgrade`	Upgrade miren CLI to latest version

version

Command	Description
`miren version`	Print the version

whoami

Command	Description
`miren whoami`	Display information about the current authenticated user

Advanced / Debug Commands

caution

These commands are intended for advanced debugging and troubleshooting. They may change without notice.

Command	Description
`miren debug`	Debug and troubleshooting commands
`miren debug bundle`	Create a support bundle with system debug information
`miren debug colors`	Print some colors
`miren debug connection`	Test connectivity and authentication with a server
`miren debug ctr`	Run ctr with miren defaults
`miren debug ctr nuke`	Nuke a containerd namespace
`miren debug disk`	Disk entity debug commands
`miren debug disk create`	Create a disk entity for testing
`miren debug disk delete`	Delete a disk entity
`miren debug disk lease`	Create a disk lease for testing
`miren debug disk lease-delete`	Delete a disk lease entity
`miren debug disk lease-list`	List all disk lease entities
`miren debug disk lease-release`	Release a disk lease
`miren debug disk lease-status`	Show detailed status of a disk lease
`miren debug disk list`	List all disk entities
`miren debug disk migrate`	Migrate LSVD volume to raw disk image
`miren debug disk mounts`	List all mounted disks from /proc/mounts
`miren debug disk status`	Show status of a disk entity
`miren debug entity`	Entity store debug commands
`miren debug entity create`	Create a new entity
`miren debug entity delete`	Delete an entity
`miren debug entity ensure`	Ensure an entity exists
`miren debug entity get`	Get an entity
`miren debug entity list`	List entities
`miren debug entity patch`	Patch an existing entity
`miren debug entity put`	Put an entity
`miren debug entity replace`	Replace an existing entity
`miren debug netdb`	Network database debug commands
`miren debug netdb gc`	Find and release orphaned IP leases
`miren debug netdb list`	List all IP leases from netdb
`miren debug netdb release`	Manually release IP leases
`miren debug netdb status`	Show IP allocation status by subnet
`miren debug rbac`	Fetch and display RBAC rules from miren.cloud
`miren debug rbac test`	Test RBAC evaluation with fetched rules
`miren debug reindex`	Rebuild all entity indexes from scratch
`miren debug test`	Debug test commands
`miren debug test load`	Loadtest a URL

addon​

admin​

alias​

app​

apps​

auth​

cluster​

config​

deploy​

disk​

doctor​

download​

env​

help​

init​

login​

logout​

logs​

rollback​

route​

runner​

sandbox​

sandbox-pool​

server​

upgrade​

version​

whoami​

Advanced / Debug Commands​

addon

admin

alias

app

apps

auth

cluster

config

deploy

disk

doctor

download

env

help

init

login

logout

logs

rollback

route

runner

sandbox

sandbox-pool

server

upgrade

version

whoami

Advanced / Debug Commands