Skip to main content

Commands

Complete reference for all miren CLI commands.

addon

CommandDescription
miren addonAddon management commands
miren addon createAttach an addon to an application (addons)
miren addon destroyRemove an addon from an application (addons)
miren addon listList addons attached to an application (addons)
miren addon list-availableList available addons (addons)
miren addon variantsShow variants for an addon (addons)

admin

CommandDescription
miren adminCall an admin method on an application

app

CommandDescription
miren appGet information about an application
miren app deleteDelete an application and all its resources
miren app historyShow deployment history for an application
miren app listList all applications
miren app runOpen interactive shell in a new sandbox
miren app statusShow current status of an application

apps

CommandDescription
miren appsList all applications (alias for 'app list')

auth

CommandDescription
miren authAuthentication commands
miren auth generateGenerate authentication config file

cluster

CommandDescription
miren clusterList configured clusters
miren cluster addAdd a new cluster configuration
miren cluster currentShow the pinned cluster for this app
miren cluster export-addressExport cluster address with TLS fingerprint for MIREN_CLUSTER
miren cluster listList all configured clusters
miren cluster removeRemove a cluster from the configuration
miren cluster switchSwitch to a different cluster

config

CommandDescription
miren configConfiguration file management
miren config infoShow configuration file locations and format
miren config loadLoad config and merge it with your current config

deploy

CommandDescription
miren deployDeploy an application
miren deploy cancelCancel an in-progress deployment

doctor

CommandDescription
miren doctorDiagnose miren environment and connectivity
miren doctor authCheck authentication and user information
miren doctor configCheck configuration files
miren doctor serverCheck server health and connectivity

download

CommandDescription
miren downloadDownload management commands
miren download releaseDownload and extract miren release

env

CommandDescription
miren envEnvironment variable management commands
miren env deleteDelete environment variables
miren env getGet an environment variable value
miren env listList all environment variables
miren env setSet environment variables for an application

init

CommandDescription
miren initInitialize a new application

login

CommandDescription
miren loginAuthenticate with miren.cloud

logout

CommandDescription
miren logoutRemove local authentication credentials

logs

CommandDescription
miren logsGet logs for an application

oidc

CommandDescription
miren oidcOIDC authentication binding management
miren oidc addAdd an OIDC binding to an application
miren oidc listList OIDC bindings for an application
miren oidc removeRemove an OIDC binding

rollback

CommandDescription
miren rollbackRoll back to a previous version

route

CommandDescription
miren routeList all HTTP routes
miren route listList all HTTP routes
miren route oidcOIDC authentication management for routes
miren route oidc disableDisable OIDC authentication for a route (routeoidc)
miren route oidc enableEnable OIDC authentication for a route (routeoidc)
miren route oidc showShow OIDC configuration for a route (routeoidc)
miren route removeRemove an HTTP route
miren route setCreate or update an HTTP route
miren route set-defaultSet an app as the default route
miren route showShow details of an HTTP route
miren route unset-defaultRemove the default route

runner

CommandDescription
miren runnerRunner management commands
miren runner inviteCreate a join code for a new runner (distributedrunners)
miren runner invite listList all runner invitations (distributedrunners)
miren runner joinJoin this machine to a coordinator as a runner (distributedrunners)
miren runner listList all registered runners (distributedrunners)
miren runner revokeRevoke a runner invitation (distributedrunners)
miren runner startStart this machine as a distributed runner (distributedrunners)

sandbox

CommandDescription
miren sandboxSandbox management commands
miren sandbox deleteDelete a dead sandbox
miren sandbox execOpen interactive shell in an existing sandbox
miren sandbox listList sandboxes (excludes dead by default)
miren sandbox stopStop a sandbox

sandbox-pool

CommandDescription
miren sandbox-poolSandbox pool management commands
miren sandbox-pool listList all sandbox pools
miren sandbox-pool set-desiredSet desired instance count for a sandbox pool

server

CommandDescription
miren serverStart the miren server
miren server configServer configuration management commands
miren server config generateGenerate a server configuration file from current settings
miren server config validateValidate a server configuration file
miren server dockerDocker-based server management commands
miren server docker installInstall miren server using Docker
miren server docker statusShow status of miren server Docker container
miren server docker uninstallUninstall miren server Docker container
miren server installInstall systemd service for miren server
miren server registerRegister this cluster with miren.cloud
miren server register statusShow cluster registration status
miren server statusShow miren service status
miren server uninstallRemove systemd service for miren server
miren server upgradeUpgrade miren server
miren server upgrade rollbackRollback server to previous version

upgrade

CommandDescription
miren upgradeUpgrade miren CLI to latest version

version

CommandDescription
miren versionPrint the version

whoami

CommandDescription
miren whoamiDisplay information about the current authenticated user

Advanced / Debug Commands

caution

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

CommandDescription
miren debugDebug and troubleshooting commands
miren debug bundleCreate a support bundle with system debug information
miren debug colorsPrint some colors
miren debug connectionTest connectivity and authentication with a server
miren debug ctrRun ctr with miren defaults
miren debug ctr nukeNuke a containerd namespace
miren debug diskDisk entity debug commands
miren debug disk createCreate a disk entity for testing
miren debug disk deleteDelete a disk entity
miren debug disk leaseCreate a disk lease for testing
miren debug disk lease-deleteDelete a disk lease entity
miren debug disk lease-listList all disk lease entities
miren debug disk lease-releaseRelease a disk lease
miren debug disk lease-statusShow detailed status of a disk lease
miren debug disk listList all disk entities
miren debug disk mountsList all mounted disks from /proc/mounts
miren debug disk statusShow status of a disk entity
miren debug entityEntity store debug commands
miren debug entity createCreate a new entity
miren debug entity deleteDelete an entity
miren debug entity ensureEnsure an entity exists
miren debug entity getGet an entity
miren debug entity listList entities
miren debug entity patchPatch an existing entity
miren debug entity putPut an entity
miren debug entity replaceReplace an existing entity
miren debug lsvdLSVD server debug commands
miren debug lsvd infoShow combined LSVD server volumes, mounts, and metrics
miren debug lsvd metricsShow LSVD reconciliation metrics
miren debug lsvd mountsList mounts managed by LSVD server
miren debug lsvd volumesList volumes managed by LSVD server
miren debug netdbNetwork database debug commands
miren debug netdb gcFind and release orphaned IP leases
miren debug netdb listList all IP leases from netdb
miren debug netdb releaseManually release IP leases
miren debug netdb statusShow IP allocation status by subnet
miren debug outboardOutboard process debug commands
miren debug outboard healthCheck health of an outboard process
miren debug rbacFetch and display RBAC rules from miren.cloud
miren debug rbac testTest RBAC evaluation with fetched rules
miren debug reindexRebuild all entity indexes from scratch
miren debug testDebug test commands
miren debug test loadLoadtest a URL