# Miren Docs

> Enjoy the Deploy

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Addons](https://miren.md/addons.md): Managed services like databases that Miren provisions and operates for your app, with automatic credential injection.
- [Admin Interface](https://miren.md/admin-interface.md): Expose custom administrative functions in your app that can be called from the CLI via JSON-RPC.
- [Agent Skills](https://miren.md/agent-skills.md): Use AI coding agents to deploy, diagnose, and manage your Miren infrastructure with pre-built skills for Claude Code, Codex, Amp, and more.
- [App Configuration](https://miren.md/app-configuration.md): How Miren detects and configures your app automatically, and when to customize with app.toml.
- [app.toml Reference](https://miren.md/app-toml.md): Complete reference for .miren/app.toml — services, scaling, disks, environment variables, and build configuration.
- [Changelog](https://miren.md/changelog.md): All notable changes to Miren Runtime, organized by release version.
- [CI/CD Deployment](https://miren.md/ci-deploy.md): Deploy to Miren from CI/CD pipelines using short-lived OIDC tokens instead of stored secrets.
- [miren addon create](https://miren.md/command/addon-create.md): Attach an addon to an application
- [miren addon destroy](https://miren.md/command/addon-destroy.md): Remove an addon from an application
- [miren addon list-available](https://miren.md/command/addon-list-available.md): List available addons
- [miren addon list](https://miren.md/command/addon-list.md): List addons attached to an application
- [miren addon variants](https://miren.md/command/addon-variants.md): Show variants for an addon
- [miren addon](https://miren.md/command/addon.md): Addon management commands
- [miren admin](https://miren.md/command/admin.md): Call an admin method on an application
- [miren alias list](https://miren.md/command/alias-list.md): List configured CLI aliases
- [miren alias](https://miren.md/command/alias.md): CLI alias management
- [miren app delete](https://miren.md/command/app-delete.md): Delete an application and all its resources
- [miren app history](https://miren.md/command/app-history.md): Show deployment history for an application
- [miren app list](https://miren.md/command/app-list.md): List all applications
- [miren app restart](https://miren.md/command/app-restart.md): Restart an application
- [miren app run](https://miren.md/command/app-run.md): Open interactive shell in a new sandbox
- [miren app status](https://miren.md/command/app-status.md): Show current status of an application
- [miren app versions](https://miren.md/command/app-versions.md): List app versions with status
- [miren app](https://miren.md/command/app.md): Get information about an application
- [miren apps](https://miren.md/command/apps.md): List all applications (alias for 'app list')
- [miren auth ci add](https://miren.md/command/auth-ci-add.md): Add a CI authentication binding to an application
- [miren auth ci list](https://miren.md/command/auth-ci-list.md): List CI authentication bindings for an application
- [miren auth ci remove](https://miren.md/command/auth-ci-remove.md): Remove a CI authentication binding
- [miren auth ci](https://miren.md/command/auth-ci.md): CI authentication binding management
- [miren auth generate](https://miren.md/command/auth-generate.md): Generate authentication config file
- [miren auth provider add github](https://miren.md/command/auth-provider-add-github.md): Add a GitHub identity provider
- [miren auth provider add oidc](https://miren.md/command/auth-provider-add-oidc.md): Add an OIDC identity provider
- [miren auth provider add password](https://miren.md/command/auth-provider-add-password.md): Add a shared-password identity provider
- [miren auth provider add](https://miren.md/command/auth-provider-add.md): Add an identity provider for route protection
- [miren auth provider list](https://miren.md/command/auth-provider-list.md): List identity providers
- [miren auth provider remove](https://miren.md/command/auth-provider-remove.md): Remove an identity provider
- [miren auth provider show](https://miren.md/command/auth-provider-show.md): Show an identity provider
- [miren auth provider](https://miren.md/command/auth-provider.md): Identity provider management
- [miren auth](https://miren.md/command/auth.md): Authentication commands
- [miren cluster add](https://miren.md/command/cluster-add.md): Add a new cluster configuration
- [miren cluster current](https://miren.md/command/cluster-current.md): Show the pinned cluster for this app
- [miren cluster export-address](https://miren.md/command/cluster-export-address.md): Export cluster address with TLS fingerprint for MIREN_CLUSTER
- [miren cluster list](https://miren.md/command/cluster-list.md): List all configured clusters
- [miren cluster remove](https://miren.md/command/cluster-remove.md): Remove a cluster from the configuration
- [miren cluster switch](https://miren.md/command/cluster-switch.md): Switch to a different cluster
- [miren cluster](https://miren.md/command/cluster.md): List configured clusters
- [miren config info](https://miren.md/command/config-info.md): Show configuration file locations and format
- [miren config load](https://miren.md/command/config-load.md): Load config and merge it with your current config
- [miren config](https://miren.md/command/config.md): Configuration file management
- [miren debug advertise](https://miren.md/command/debug-advertise.md): Show which addresses the server would advertise and why
- [miren debug bundle](https://miren.md/command/debug-bundle.md): Create a support bundle with system debug information
- [miren debug colors](https://miren.md/command/debug-colors.md): Print some colors
- [miren debug connection](https://miren.md/command/debug-connection.md): Test connectivity and authentication with a server
- [miren debug ctr nuke](https://miren.md/command/debug-ctr-nuke.md): Nuke a containerd namespace
- [miren debug ctr](https://miren.md/command/debug-ctr.md): Run ctr with miren defaults
- [miren debug disk create](https://miren.md/command/debug-disk-create.md): Create a disk entity for testing
- [miren debug disk delete](https://miren.md/command/debug-disk-delete.md): Delete a disk entity
- [miren debug disk lease-delete](https://miren.md/command/debug-disk-lease-delete.md): Delete a disk lease entity
- [miren debug disk lease-list](https://miren.md/command/debug-disk-lease-list.md): List all disk lease entities
- [miren debug disk lease-release](https://miren.md/command/debug-disk-lease-release.md): Release a disk lease
- [miren debug disk lease-status](https://miren.md/command/debug-disk-lease-status.md): Show detailed status of a disk lease
- [miren debug disk lease](https://miren.md/command/debug-disk-lease.md): Create a disk lease for testing
- [miren debug disk list](https://miren.md/command/debug-disk-list.md): List all disk entities
- [miren debug disk migrate](https://miren.md/command/debug-disk-migrate.md): Migrate LSVD volume to raw disk image
- [miren debug disk mounts](https://miren.md/command/debug-disk-mounts.md): List all mounted disks from /proc/mounts
- [miren debug disk status](https://miren.md/command/debug-disk-status.md): Show status of a disk entity
- [miren debug disk](https://miren.md/command/debug-disk.md): Disk entity debug commands
- [miren debug entity create](https://miren.md/command/debug-entity-create.md): Create a new entity
- [miren debug entity delete](https://miren.md/command/debug-entity-delete.md): Delete an entity
- [miren debug entity ensure](https://miren.md/command/debug-entity-ensure.md): Ensure an entity exists
- [miren debug entity get](https://miren.md/command/debug-entity-get.md): Get an entity
- [miren debug entity list](https://miren.md/command/debug-entity-list.md): List entities
- [miren debug entity patch](https://miren.md/command/debug-entity-patch.md): Patch an existing entity
- [miren debug entity put](https://miren.md/command/debug-entity-put.md): Put an entity
- [miren debug entity replace](https://miren.md/command/debug-entity-replace.md): Replace an existing entity
- [miren debug entity](https://miren.md/command/debug-entity.md): Entity store debug commands
- [miren debug netdb gc](https://miren.md/command/debug-netdb-gc.md): Find and release orphaned IP leases
- [miren debug netdb list](https://miren.md/command/debug-netdb-list.md): List all IP leases from netdb
- [miren debug netdb release](https://miren.md/command/debug-netdb-release.md): Manually release IP leases
- [miren debug netdb status](https://miren.md/command/debug-netdb-status.md): Show IP allocation status by subnet
- [miren debug netdb](https://miren.md/command/debug-netdb.md): Network database debug commands
- [miren debug rbac test](https://miren.md/command/debug-rbac-test.md): Test RBAC evaluation with fetched rules
- [miren debug rbac](https://miren.md/command/debug-rbac.md): Fetch and display RBAC rules from miren.cloud
- [miren debug reindex](https://miren.md/command/debug-reindex.md): Rebuild all entity indexes from scratch
- [miren debug test load](https://miren.md/command/debug-test-load.md): Loadtest a URL
- [miren debug test](https://miren.md/command/debug-test.md): Debug test commands
- [miren debug](https://miren.md/command/debug.md): Debug and troubleshooting commands
- [miren deploy cancel](https://miren.md/command/deploy-cancel.md): Cancel an in-progress deployment
- [miren deploy](https://miren.md/command/deploy.md): Deploy an application
- [miren disk backup](https://miren.md/command/disk-backup.md): Backup a disk to a snapshot file
- [miren disk list-deleted](https://miren.md/command/disk-list-deleted.md): List deleted disks available for recovery
- [miren disk restore](https://miren.md/command/disk-restore.md): Restore a disk from a snapshot file
- [miren disk undelete](https://miren.md/command/disk-undelete.md): Restore a recently deleted disk
- [miren disk](https://miren.md/command/disk.md): Disk backup and recovery
- [miren doctor auth](https://miren.md/command/doctor-auth.md): Check authentication and user information
- [miren doctor config](https://miren.md/command/doctor-config.md): Check configuration files
- [miren doctor server](https://miren.md/command/doctor-server.md): Check server health and connectivity
- [miren doctor](https://miren.md/command/doctor.md): Diagnose miren environment and connectivity
- [miren download release](https://miren.md/command/download-release.md): Download and extract miren release
- [miren download](https://miren.md/command/download.md): Download management commands
- [miren env delete](https://miren.md/command/env-delete.md): Delete environment variables
- [miren env get](https://miren.md/command/env-get.md): Get an environment variable value
- [miren env list](https://miren.md/command/env-list.md): List all environment variables
- [miren env set](https://miren.md/command/env-set.md): Set environment variables for an application
- [miren env](https://miren.md/command/env.md): Environment variable management commands
- [miren help](https://miren.md/command/help.md): Show help for one or more commands
- [miren init](https://miren.md/command/init.md): Initialize a new application
- [miren login](https://miren.md/command/login.md): Authenticate with miren.cloud
- [miren logout](https://miren.md/command/logout.md): Remove local authentication credentials
- [miren logs app](https://miren.md/command/logs-app.md): View application logs
- [miren logs build](https://miren.md/command/logs-build.md): View build logs
- [miren logs sandbox](https://miren.md/command/logs-sandbox.md): View sandbox logs
- [miren logs system](https://miren.md/command/logs-system.md): View system logs
- [miren logs](https://miren.md/command/logs.md): View logs (defaults to app logs)
- [miren rollback](https://miren.md/command/rollback.md): Roll back to a previous version
- [miren route list](https://miren.md/command/route-list.md): List all HTTP routes
- [miren route protect](https://miren.md/command/route-protect.md): Protect an HTTP route with an identity provider
- [miren route remove](https://miren.md/command/route-remove.md): Remove an HTTP route
- [miren route set-default](https://miren.md/command/route-set-default.md): Set an app as the default route
- [miren route set](https://miren.md/command/route-set.md): Create or update an HTTP route
- [miren route show](https://miren.md/command/route-show.md): Show details of an HTTP route
- [miren route unprotect](https://miren.md/command/route-unprotect.md): Remove identity-provider protection from an HTTP route
- [miren route unset-default](https://miren.md/command/route-unset-default.md): Remove the default route
- [miren route waf](https://miren.md/command/route-waf.md): Manage WAF protection on an HTTP route
- [miren route](https://miren.md/command/route.md): List all HTTP routes
- [miren runner install](https://miren.md/command/runner-install.md): Install systemd service for miren runner
- [miren runner join](https://miren.md/command/runner-join.md): Join this machine to a coordinator as a runner
- [miren runner list](https://miren.md/command/runner-list.md): List all registered runners
- [miren runner remove](https://miren.md/command/runner-remove.md): Remove a registered runner and clean up resources
- [miren runner service-status](https://miren.md/command/runner-service-status.md): Show miren-runner systemd service status
- [miren runner start](https://miren.md/command/runner-start.md): Start this machine as a distributed runner
- [miren runner status](https://miren.md/command/runner-status.md): Show runner health and configuration
- [miren runner token create](https://miren.md/command/runner-token-create.md): Create a join token for a runner
- [miren runner token list](https://miren.md/command/runner-token-list.md): List all join tokens
- [miren runner token revoke](https://miren.md/command/runner-token-revoke.md): Revoke a join token
- [miren runner token](https://miren.md/command/runner-token.md): Manage join tokens
- [miren runner uninstall](https://miren.md/command/runner-uninstall.md): Remove systemd service for miren runner
- [miren runner upgrade rollback](https://miren.md/command/runner-upgrade-rollback.md): Rollback runner to previous version
- [miren runner upgrade](https://miren.md/command/runner-upgrade.md): Upgrade miren runner to the latest or specified version
- [miren runner](https://miren.md/command/runner.md): Runner management commands
- [miren sandbox delete](https://miren.md/command/sandbox-delete.md): Delete a dead sandbox
- [miren sandbox exec](https://miren.md/command/sandbox-exec.md): Open interactive shell in an existing sandbox
- [miren sandbox list](https://miren.md/command/sandbox-list.md): List sandboxes (excludes dead by default)
- [miren sandbox-pool list](https://miren.md/command/sandbox-pool-list.md): List all sandbox pools
- [miren sandbox-pool set-desired](https://miren.md/command/sandbox-pool-set-desired.md): Set desired instance count for a sandbox pool
- [miren sandbox-pool](https://miren.md/command/sandbox-pool.md): Sandbox pool management commands
- [miren sandbox stop](https://miren.md/command/sandbox-stop.md): Stop a sandbox
- [miren sandbox](https://miren.md/command/sandbox.md): Sandbox management commands
- [miren server config generate](https://miren.md/command/server-config-generate.md): Generate a server configuration file from current settings
- [miren server config validate](https://miren.md/command/server-config-validate.md): Validate a server configuration file
- [miren server config](https://miren.md/command/server-config.md): Server configuration management commands
- [miren server docker install](https://miren.md/command/server-docker-install.md): Install miren server using Docker
- [miren server docker status](https://miren.md/command/server-docker-status.md): Show status of miren server Docker container
- [miren server docker uninstall](https://miren.md/command/server-docker-uninstall.md): Uninstall miren server Docker container
- [miren server docker](https://miren.md/command/server-docker.md): Docker-based server management commands
- [miren server install](https://miren.md/command/server-install.md): Install systemd service for miren server
- [miren server register status](https://miren.md/command/server-register-status.md): Show cluster registration status
- [miren server register](https://miren.md/command/server-register.md): Register this cluster with miren.cloud
- [miren server status](https://miren.md/command/server-status.md): Show miren service status
- [miren server uninstall](https://miren.md/command/server-uninstall.md): Remove systemd service for miren server
- [miren server upgrade rollback](https://miren.md/command/server-upgrade-rollback.md): Rollback server to previous version
- [miren server upgrade](https://miren.md/command/server-upgrade.md): Upgrade miren server
- [miren server](https://miren.md/command/server.md): Start the miren server
- [miren upgrade](https://miren.md/command/upgrade.md): Upgrade miren CLI to latest version
- [miren version](https://miren.md/command/version.md): Print the version
- [miren whoami](https://miren.md/command/whoami.md): Display information about the current authenticated user
- [Commands](https://miren.md/commands.md): Complete reference for all miren CLI commands
- [Code of Conduct](https://miren.md/conduct.md): The Miren community code of conduct — guidelines for respectful and inclusive participation.
- [Deployment](https://miren.md/deployment.md): How miren deploy works — uploading code, building images, and activating new versions.
- [Persistent Storage](https://miren.md/disks.md): Configure persistent storage for your app using local storage or Miren Disks managed volumes.
- [Firewall Configuration](https://miren.md/firewall.md): How Miren configures iptables rules for container networking and how to troubleshoot networking issues.
- [Getting Started](https://miren.md/getting-started.md): Install Miren, set up a server, and deploy your first app in minutes.
- [Miren](https://miren.md/docs/intro.md): Miren is a container platform for small teams — deploy apps to a Linux server with builds, scaling, routing, TLS, and backups built in.
- [Miren Labs](https://miren.md/labs.md): Experimental features available for early access and feedback before stable release.
- [Supported Languages](https://miren.md/languages.md): Languages and frameworks Miren detects automatically, including build and runtime configuration.
- [Logs](https://miren.md/logs.md): View and query application, build, sandbox, and system logs with the miren logs command.
- [Cloud Updates](https://miren.md/miren-cloud/cloud-updates.md): What's new in Miren Cloud — feature releases, fixes, and improvements.
- [Miren Cloud](https://miren.md/miren-cloud/overview.md): Central control plane for managing Miren clusters — team access, backups, multi-environment workflows, and custom subdomains.
- [Subdomains](https://miren.md/miren-cloud/subdomains.md): Claim a custom subdomain like mycluster.run.garden for your Miren cluster with automatic DNS and wildcard routing.
- [Observability](https://miren.md/observability.md): OpenTelemetry distributed tracing for the request lifecycle, including routing, sandbox management, and container operations.
- [Pull Request Environments](https://miren.md/pr-environments.md): Deploy a labeled, time-boxed preview of your app on a subdomain — one per pull request, with automatic cleanup.
- [Protecting Routes](https://miren.md/route-protect.md): Add single sign-on to your app's HTTP routes using OIDC, with identity passed as headers.
- [Application Scaling](https://miren.md/scaling.md): How Miren autoscales your app based on traffic, and how to configure scaling behavior.
- [Server Configuration Reference](https://miren.md/server-config.md): Complete reference for Miren server configuration — config file, environment variables, and CLI flags.
- [Services](https://miren.md/services.md): Run multiple processes in a single app — web servers, workers, databases — each with independent scaling.
- [System Requirements](https://miren.md/system-requirements.md): Minimum and recommended hardware for running a Miren server — OS, architecture, memory, and storage.
- [Terminology](https://miren.md/terminology.md): Definitions of common terms used in Miren — apps, clusters, sandboxes, services, and more.
- [TLS Certificates](https://miren.md/tls.md): Automatic TLS certificate provisioning via Let's Encrypt, including DNS challenges and custom certificates.
- [Traffic Routing](https://miren.md/traffic-routing.md): Route HTTP traffic to apps via hostnames, and configure non-HTTP ports for TCP/UDP services.
- [Troubleshooting](https://miren.md/troubleshooting.md): Step-by-step guide to diagnosing issues with Miren applications, builds, networking, and server health.
- [Web Application Firewall (WAF)](https://miren.md/waf.md): Protect your apps from common web attacks with built-in OWASP WAF filtering at the routing layer.