Metaplay Docs

Appearance

metaplay init sdk [flags]

Download the Metaplay SDK into the current project

metaplay init sdk [flags] ​

Download and extract a Metaplay SDK release into the current project.

The SDK is extracted to the sdkRootDir directory set in metaplay-project.yaml. An existing SDK is replaced only after confirmation, or with --overwrite.

Use this for projects that come without the SDK, such as the Metaplay samples and starter projects listed at https://docs.metaplay.io/introduction/sample-projects-overview Coding agents: read the documentation with 'metaplay llm-docs read <url>'.

To change the SDK version of a project that already has one, use 'metaplay update sdk'.

You must be logged in to the Metaplay portal (use 'metaplay auth login') and have agreed to the privacy policy and terms & conditions in the portal (https://portal.metaplay.dev).

Examples ​

sh
# Download SDK v34.0 into the current project (creates ./MetaplaySDK/)
metaplay init sdk --sdk-version=34.0
# Download SDK v34.0 into a custom directory (creates ./Vendor/MetaplaySDK/)
metaplay init sdk --sdk-version=34.0 --sdk-directory=Vendor/MetaplaySDK

Flags ​

  • --auto-agree: Automatically agree to the privacy policy and terms and conditions
  • --overwrite: Remove existing MetaplaySDK/ directory and replace with new contents
  • --sdk-directory <string>: Path of the MetaplaySDK directory to create
  • --sdk-version <string>: Metaplay SDK version to download

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]