image

Last updated: May 29, 2026

Provides commands for interacting with game images.

Authentication

This command group currently requires legacy credentials (AccessKey and SecretKey). Onboarded users are typically provided these in mpcli.json as a temporary compatibility path.

The credentials within the mpcli.json file should be listed inline. Please see this example:

mpcli image update \
  --imageid 12345 \
  --machineid 67890 \
  --description "v1707159688" \
  --url "s3://AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI%2FK7MDENG%2FbPxRfiCYEXAMPLEKEY@mybucket/mygamefilesv1/"

Shortcut and intermediary steps

For most users, image deploy is the recommended shortcut command.

Use the intermediary commands when you need to debug, resume, or control each stage independently.

  1. image sync

  2. image update

  3. image diff

  4. image version

When to use this command

Use mpcli image deploy to update an existing build's files end-to-end. It is the recommended command for the common case of "I have new server files; push them as a new version of my build". For granular control over individual pipeline stages (debugging a stuck deploy, etc.), see mpcli build update.

Group usage

mpcli image [command] [flags]

Group flags

Commands

sync

Note This command requires legacy credentials (AccessKey and SecretKey).

Synchronize a local directory to image storage.

mpcli image sync [flags]

Flags:

update

Note This command requires legacy credentials (AccessKey and SecretKey).

Create or resume an image update job.

mpcli image update [flags]

Flags:

diff

Note This command requires legacy credentials (AccessKey and SecretKey).

Create or resume an image diff job.

mpcli image diff [flags]

Flags:

diff reject

Note This command requires legacy credentials (AccessKey and SecretKey).

Reject a diff, optionally with reinstall.

mpcli image diff reject [flags]

Flags:

version

Note This command requires legacy credentials (AccessKey and SecretKey).

Create or resume an image version job.

mpcli image version [flags]

Flags:

status

Note This command requires legacy credentials (AccessKey and SecretKey).

Check image deployment status.

mpcli image status [flags]

Flags:

deploy

Note This command requires legacy credentials (AccessKey and SecretKey).

Run the full deploy pipeline (sync -> update -> diff -> version). This is the shortcut command for normal image rollout workflows.

Validation rule: do not provide both --source and --url in the same deploy invocation.

mpcli image deploy [flags]

Flags:

Related

  • Global flags

  • Command reference index