Skip to main content

Entity Commands

Commands for interacting with Miren's entity store.

info

Entities are the low-level objects stored in Miren's entity system. Most users won't need to use these commands directly. They're primarily useful for debugging and advanced use cases.

What are Entities?​

Entities are flexible metadata objects stored in Miren's etcd-backed entity store. Everything in Miren is an entity:

  • Apps - Application definitions
  • Sandboxes - Running containers
  • Versions - Immutable app configurations
  • Clusters - Cluster registrations
  • Users - User accounts

miren debug entity list​

List entities of a specific type.

Usage​

miren debug entity list <type> [flags]

Examples​

# List all apps
miren debug entity list app

# List all sandboxes
miren debug entity list sandbox

miren debug entity get​

Get a specific entity by type and name.

Usage​

miren debug entity get <type> <name> [flags]

Examples​

# Get an app entity
miren debug entity get app myapp

# Get a sandbox entity
miren debug entity get sandbox sb-abc123

miren debug entity delete​

Delete an entity.

Usage​

miren debug entity delete <type> <name> [flags]

Examples​

# Delete an entity
miren debug entity delete app myapp

miren debug entity put​

Put (create or update) an entity.

Usage​

miren debug entity put <type> <name> [flags]
warning

This is an advanced command. Use the higher-level commands like miren deploy instead when possible.

Next Steps​