Cast To Cloud
Docs
CLI Setup

CLI Setup

Install the CLI and configure your first API key to get up and running.

Overview

The CLI is developer-focused commandline executable. It is useful in 2 scenarios:

  • The Unreal Plugin will install and run the CLI when needed (e.g.: to monitor the UBT process from the outside for the Build Coordinator)
  • Inside CI/CD pipelines to automate processes (e.g.: uploading PDB files to the symbols storage at the end of a build)

Install the CLI

Install:

irm https://api.casttocloud.com/cli/install.ps1 | iex

Check version:

./casttocloud-cli.exe --version

Configure API Key

The CLI accepts an API Key using the --api-key arg. It is used to authentificate when performing requests against the platform API.

When invoked by the Unreal Plugin, the Developer API Key from the Project Settings will be passed to the CLI automatically.

For automated tasks (e.g.: uploading symbols) you will need to manually generate an API Keys with the required permissions following the API Keys documentation.

Unreal PluginAPI Keys