Skip to main content

Commands

This guide offers some basic information for the CLI's commands which are not yet documented elsewhere. To view the API of each command, run mantle help [SUBCOMMAND].

Deploy​

Deploy a Mantle project. For a detailed walkthrough, see the Getting Started guide.

Outputs​

If you want to know the ID of a resource which Mantle created so you can reference it in your game, you can run mantle outputs from your project directory.

After deploying the getting-started example project for the first time, running the outputs command will print something like this:

$mantle deploy
Load outputs:
  â•·
  │  Loaded config file projects/getting-started/mantle.yml
  │  Selected provided environment configuration dev
  │  Loading previous state from local file projects/getting-started/.mantle-state.yml
  │
  ╰─ Succeeded

{
  "experienceActivation_singleton": "experienceActivation",
  "experienceConfiguration_singleton": "experienceConfiguration",
  "experience_singleton": {
    "experience": {
      "assetId": 3296599132,
      "startPlaceId": 8667346609
    }
  },
  "placeConfiguration_start": "placeConfiguration",
  "placeFile_start": {
    "placeFile": {
      "version": 2
    }
  },
  "place_start": {
    "place": {
      "assetId": 8667346609
    }
  }
}

Destroying​

If you want to destroy a deployment you can run mantle destroy from your project directory.

Importing​

Mantle provides an import feature so that you can deploy to an existing experience with Mantle.

caution

The import feature DOES NOT convert your existing Roblox project into a Mantle project. Do not import, then deploy a place with Mantle without first testing on a staging environment as you may destroy your assets.

After creating a staging environment with Mantle that is on-par with your production environment, you can import your production environment into Mantle so that you can deploy to it. This feature is still experimental and does not do a good job of matching existing resources to configured ones so most resources will be recreated.

Run mantle import --environment <your-environment> --target-id <experience-id>.