Skip to main content

CLI Reference

The Miren CLI (miren) provides commands for managing applications and deployments.

Core Commands​

Deployment​

  • miren deploy - Deploy the current project
  • miren deploy --analyze - Analyze the project without deploying (dry-run)
  • miren init - Initialize a new application

Deploy Options​

FlagDescription
--analyzeAnalyze the app without building or deploying. Shows detected stack, services, and configuration.
--forceForce deployment even if no changes detected
--waitWait for deployment to complete

Server Install​

  • miren server install - Usually run via sudo, setup the server with systemd
  • miren server uninstall - Run as root, remove the global server install
  • miren server docker install - Setup a server in the local docker
  • miren server docker uninstall - Remove the server running within docker

Application Management​

  • miren app - Get information and metrics about an application (details)
  • miren app list (or miren apps) - List all applications
  • miren app delete - Delete an application and all its resources
  • miren app history - Show deployment history for an application
  • miren app status - Show current status of an application
  • miren app run - Open interactive shell in a new ephemeral sandbox (details)

Logs & Monitoring​

  • miren logs - Get logs for an application (details)
  • miren route - List all HTTP routes

Environment & Configuration​

  • miren env - Environment variable management commands
  • miren config - Configuration file management

Cluster & Authentication​

  • miren cluster - List configured clusters
  • miren cluster list - List all configured clusters
  • miren cluster add - Add a new cluster configuration
  • miren cluster remove - Remove a cluster from the configuration
  • miren cluster switch - Switch to a different cluster
  • miren login - Authenticate with miren.cloud
  • miren server register - Register this cluster with miren.cloud
  • miren whoami - Display information about the current authenticated user

Advanced Commands​

  • miren sandbox list - List all sandboxes (details)
  • miren sandbox exec - Execute a command in an existing sandbox (details)
  • miren sandbox stop - Stop a sandbox
  • miren sandbox delete - Delete a dead sandbox
  • miren sandbox metrics - Get metrics from a sandbox
  • miren debug entity list - List entities
  • miren debug entity get - Get an entity
  • miren debug entity delete - Delete an entity
  • miren debug entity put - Put an entity

Disk Commands​

  • miren debug disk list - List all disk entities
  • miren debug disk status - Show status of a disk entity
  • miren debug disk create - Create a disk entity
  • miren debug disk delete - Delete a disk entity
  • miren debug disk lease-list - List all disk leases
  • miren debug disk lease-status - Show status of a disk lease
  • miren debug disk lease-release - Release a disk lease
  • miren debug disk mounts - List mounted disks

Utility Commands​

  • miren version - Print the version
  • miren upgrade - Upgrade miren CLI to latest version
  • miren server - Start the miren server

Global Flags​

These flags are available for most commands:

  • -v, --verbose - Enable verbose output
  • --server-address - Server address to connect to
  • --config - Path to the config file
  • -C, --cluster - Cluster name
  • -a, --app - Application name
  • -d, --dir - Directory to run from

Configuration​

The CLI reads configuration from ~/.config/miren/clientconfig.yaml:

server: http://localhost:8080
auth:
  token: <your-auth-token>

Authentication​

Login to Miren Cloud​

miren login

Install a Server on Linux​

sudo miren server install -n my-cluster

Install a Server inside Docker​

miren server docker install -n my-cluster

Output Formats​

Many commands support different output formats:

# Table format (default)
miren app list

# JSON format
miren app list --format json

Next Steps​