Metaplay Docs

Appearance

metaplay debug shell [ENVIRONMENT] [POD] [flags]

Start a debug container targeting the specified pod

metaplay debug shell [ENVIRONMENT] [POD] [flags] ​

Start a debug container targeting a game server pod in the specified environment. This command creates a Kubernetes ephemeral debug container that attaches to an existing game server pod, allowing you to inspect and troubleshoot the running server.

If multiple game server pods are running in the environment, you must specify which pod to debug by providing its name as the second argument. If only one pod is running, the pod name is optional.

The debug container uses the metaplay/diagnostics:latest image which contains various debugging and diagnostic tools. The container is attached to the shard-server container within the pod, giving you direct access to the game server process.

Expected arguments:

  • ENVIRONMENT (optional) -- Target environment, eg, 'lovely-wombats-build-nimbly'.
  • POD (optional) -- Target pod name, eg, 'all-0'.

Examples ​

sh
# Start a debug container in the 'nimbly' environment, interactively choose target pod.
metaplay debug shell nimbly
# Start a debug container in the 'nimbly' environment, targeting pod 'service-0'.
metaplay debug shell nimbly service-0

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]