CLI & AI toolsCommand reference helix unreal
Prepare Unreal 5.8 projects for publishing to HELIX
CLI version 0.1.27-helix3.551. Run helix unreal --help for the text your installed build prints.
Prepare Unreal 5.8 projects for publishing to HELIX
Create the publish manifest for a shared-runtime or native-game project
helix unreal init [options] [project]
| Argument | Required | Description |
|---|
project | no | project directory |
| Option | Description |
|---|
--mode <mode> | shared-runtime or native-game (required) |
--networking <mode> | unreal-native, helixnet, custom, or none (default "none") |
--runtime-version <version> | pinned HELIX Unreal runtime version (shared-runtime only) |
--force | replace an existing helix.unreal.json |
--json | machine-readable result |
Check publish readiness; with --engine or --fix, also run the in-editor HELIX Project Doctor
helix unreal doctor [options] [project]
| Argument | Required | Description |
|---|
project | no | project directory or .uproject file |
| Option | Description |
|---|
--engine | additionally run the SDK Project Doctor commandlet (needs UE_ROOT) |
--fix | apply every automatable in-editor fix, then re-scan (implies --engine) |
--json | machine-readable report |
Validate the project and HELIX publish manifest without requiring editor MCP
helix unreal validate [options] [project]
| Argument | Required | Description |
|---|
project | no | project directory or .uproject file |
| Option | Description |
|---|
--json | machine-readable validation report |
Fetch the signed client-delivery response for a published World build
helix unreal delivery [options]
| Option | Description |
|---|
--world <id> | world id (required) |
--build <id> | build id (required) |
--out <file> | where to write the response (default "world-delivery.json") |
--raw | write the whole HTTP response instead of its item payload |
--json | machine-readable result |
Build the Continuum World Release document for a cooked Unreal World
helix unreal release [options] <publishDir>
| Argument | Required | Description |
|---|
publishDir | yes | a publish output directory (the one holding world-build-manifest.json) |
| Option | Description |
|---|
--world <uuid> | world id (required) |
--release <uuid> | release id (required) |
--package <uuid> | the Continuum package the descriptor was published as (required) |
--package-version <version> | that package version (required) |
--version <version> | release version (default "1.0.0") |
--max-players <n> | runtime policy max players (default "1") |
--rating <rating> | everyone, teen, or mature (default "everyone") |
--avatar-mode <mode> | universal or world-default (default: universal) (default "universal") |
--out <file> | where to write it (default: <publishDir>/continuum/world-release.json) |
--json | machine-readable result |
Assemble validated cooked/native artifacts into a local upload-shaped directory
helix unreal package [options] [project]
| Argument | Required | Description |
|---|
project | no | project directory |
| Option | Description |
|---|
--out <directory> | output directory (default: <project>/dist/helix-unreal-package) |
--force | replace the exact output directory if it already exists |
--json | machine-readable package result |
Upload a cooked Unreal world to HELIX and promote it as the world’s active build
helix unreal publish [options] [candidate]
| Argument | Required | Description |
|---|
candidate | no | the cook output directory containing world-build-manifest.json |
| Option | Description |
|---|
--world <slug-or-id> | the HELIX world to publish this build to (required) |
--max-players <count> | players per instance (1-1000) (default "32") |
--activity <id> | activity id for the entry map (default "default") |
--idempotency-key <key> | override the key derived from the cooked manifest |
--visibility <visibility> | private, unlisted, or public — sets the world’s catalog visibility on promote |
--no-promote | upload and verify the build but leave the active release unchanged |
--verify-delivery | after promoting, confirm what a client would download |
--json | machine-readable result |