This reference is regenerated automatically during both public docs and llm-docs payload builds. No manual regeneration step is required.

Metaplay CLI installation instructions and source code is available at https://github.com/metaplay/cli. This page is a quick reference for available commands. You can access this same reference with the metaplay help command.

Root Command

metaplay [flags]

Metaplay CLI for development, deployment, and operations

Examples

# Initialize a new Metaplay project in an existing Unity project
MyGame$ metaplay init project
# Run your game server locally for development
MyGame$ metaplay dev server
# Manually deploy your game server to a cloud environment
MyGame$ metaplay build image
  MyGame$ metaplay deploy server
# View server logs in a cloud environment
MyGame$ metaplay debug logs

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]

Command Families

We have divided our commands into families to group related functionality together. Open the family pages for more details on each available command.

• auth - Authenticate to Metaplay Cloud (login, logout, machine-login, whoami)
• build - Build game server components locally (botclient, dashboard, image, server)
• completion - Generate the autocompletion script for the specified shell (bash, fish, powershell, zsh)
• database - Database management commands (export-snapshot, import-snapshot, reset)
• debug - Debug and diagnostic commands (admin-request, collect-cpu-profile, collect-heap-dump, database, logs, server-status, shell)
• deploy - Deploy server or bots into the cloud (botclient, server)
• dev - Commands for local development (botclient, clean-dashboard-artifacts, dashboard, export-cli-reference, image, server)
• get - Get information about cloud resources (aws-credentials, environment-info, kubeconfig, sdk-versions, server-info)
• help - Help about any command
• image - Commands for managing server Docker images (push)
• init - Initialize project features (ci, dashboard, project, project-config)
• remove - Remove deployed components from the cloud (botclient, server)
• secrets - Manage Kubernetes secrets of an environment (create, delete, list, show, update)
• test - Developer testing and verification commands (integration)
• update - Update components or tools in the project (cli, project-environments, sdk)
• version - Print the version information of this CLI