Skip to main content
Version: v4 (current)

Other Commands

Beyond build and the standalone orchestrate provider command, the standalone Orchestrator CLI provides commands for license preflight, cache inspection, provider protocol serving, environment diagnostics, version information, and self-updating.

activate

Verify and prepare Unity license activation. Checks that valid license credentials are available before running builds.

game-ci activate

The activate command checks for license credentials from environment variables and reports whether activation will succeed. License activation itself is handled automatically when a build runs.

License Methods

Provide credentials via environment variables:

VariableDescription
UNITY_SERIALSerial key (Professional/Plus licenses)
UNITY_LICENSEContents of a .ulf license file (base64 or raw XML)
# Using a serial key
UNITY_SERIAL=XX-XXXX-XXXX-XXXX-XXXX-XXXX game-ci activate

# Using a license file
export UNITY_LICENSE="$(cat ~/Unity_v2022.x.ulf)"
game-ci activate

Flags

FlagDefaultDescription
--unity-versionautoVersion of Unity to activate
--unity-licensing-server(empty)Unity floating license server address
# Using a floating license server
game-ci activate --unity-licensing-server http://license-server:8080

orchestrate cache

Manage build caches under the direct Orchestrator command. Caches store the Unity Library folder or engine-specific cache folders and other intermediate artifacts to speed up subsequent builds.

game-ci orchestrate cache <action> [options]

The <action> positional argument is required and must be one of: list, restore, or clear.

cache list

List cache status, including Library folder presence and any cache archives:

game-ci orchestrate cache list

Output includes Library folder path, entry count, last-modified timestamp, and key subdirectory status (PackageCache, ScriptAssemblies, ShaderCache, Bee).

cache restore

Check for available cache archives to restore:

game-ci orchestrate cache restore --cache-dir ./my-cache

cache clear

Remove cache archive files:

game-ci orchestrate cache clear

Cache Flags

FlagDefaultDescription
--cache-dir(empty)Path to the cache directory (defaults to <project-path>/Library)
--project-path.Path to the Unity project

serve

Run Orchestrator as a JSON provider protocol server. This is primarily for executable provider integrations with the public GameCI CLI, not for day-to-day user workflows.

echo '{"command":"list-resources","params":{}}' | game-ci serve --provider-strategy aws

serve reads one JSON request from stdin, dispatches it to the selected provider, and writes one JSON response to stdout. Logs are written to stderr so callers can separate machine-readable responses from human-readable output.

Supported protocol commands include:

Protocol commandPurpose
setup-workflowPrepare provider resources for a workflow.
cleanup-workflowClean up provider resources after a workflow.
run-taskRun a task in the selected provider.
garbage-collectRemove old provider/cache resources.
list-resourcesList provider resources.
list-workflowList workflow state.
watch-workflowStream or poll workflow output.

status

Display information about the current environment, useful for debugging setup issues:

game-ci status

Reports:

  • Project - detected Unity project path and whether a project was found
  • Unity Version - version detected from ProjectSettings/ProjectVersion.txt
  • Library Cache - whether the Library folder is present and when it was last modified
  • Build Outputs - any existing build output directories
  • Environment - platform, Node.js version, and which license environment variables are set (UNITY_SERIAL, UNITY_LICENSE, UNITY_EMAIL, UNITY_PASSWORD - shown as Set/Not set)
  • Docker - whether Docker is available and its version

Flags

FlagDefaultDescription
--project-path.Path to the Unity project

version

Print the installed CLI version, Node.js version, and platform:

game-ci version
game-ci (@game-ci/orchestrator) v3.0.0
Node.js v20.5.1
Platform: win32 x64

update

Update the game-ci CLI to the latest version. Downloads the appropriate binary from the orchestrator GitHub Releases for your platform and architecture.

game-ci update

Flags

FlagDefaultDescription
--force, -ffalseForce update even if already on the latest version
--version(empty)Update to a specific version (e.g. v2.1.0)
# Update to the latest version
game-ci update

# Update to a specific version
game-ci update --version v2.1.0

# Force reinstall of the current version
game-ci update --force

If running via Node.js (not as a standalone binary), the command will print instructions for updating via npm instead.

Global Flags

These flags are available on all commands:

FlagDescription
--help, -hShow help for any command
# Get help for any command
game-ci build --help
game-ci orchestrate --help
game-ci orchestrate cache --help
game-ci serve --help

See Also