HELIX Docs
CLI & AI toolsCommand reference

helix world

World tools — create the world's identity before publishing, and measure a built world's geometry as data instead of eyeballing screenshots

CLI version 0.1.27-helix3.551. Run helix world --help for the text your installed build prints.

helix world

World tools — create the world's identity before publishing, and measure a built world's geometry as data instead of eyeballing screenshots

helix world <command>

helix world create

Mint the world ROW — a Draft with no build — so products and achievements can be registered BEFORE the first publish. Idempotent: a world of yours that already has the slug is printed, never re-created

helix world create [options]
OptionDescription
--slug <slug>URL identifier: 3-50 chars, lowercase letters/digits/hyphens, globally unique (default: the slug in helix.json)
--title <title>display name, max 80 chars (default: the title in helix.json)
--description <text>catalog description, max 1000 chars
--server-creation-permission <value>who may stand up a persistent server for it: creator | collaborators | anyone (server default: anyone)
--jsonmachine-readable output

helix world scene-source

Inventory and compile rights-clean native Scene v2 source packages

helix world scene-source <command>

helix world scene-source inventory

Hash and inventory one supported source archive without extracting it

helix world scene-source inventory <source> <archive>
ArgumentRequiredDescription
sourceyeshelsinki-672496d1 or bistro-interior
archiveyesimmutable original ZIP

helix world scene-source compile

Compile deterministic proxy/detail GLBs and an existing-schema Scene v2 package

helix world scene-source compile [options] <source> <archive>
ArgumentRequiredDescription
sourceyeshelsinki-672496d1 or bistro-interior
archiveyesimmutable original ZIP
OptionDescription
-o, --output <dir>empty/new output directory for generated artifacts (required)

helix world scene-source compile-pack

Compile a directory of FBX/OBJ/GLB meshes into N individually placed, independently streamed Scene v2 nodes

helix world scene-source compile-pack [options] <pack>
ArgumentRequiredDescription
packyesdirectory containing mesh files (searched recursively)
OptionDescription
-o, --output <dir>empty/new output directory for generated artifacts (required)
--title <title>Scene title (default "Multi-asset import")
--source-id <id>stable identifier for the source pack, e.g. kit-city-01 (required)
--license <name>the pack's actual license name, e.g. 'CC0 1.0' or 'CC BY 4.0' (required)
--license-url <url>URL of the license text (required)
--creator <creator>attribution for the source pack (required)
--source-url <url>where the pack was obtained (required)
--default-materialsswap imported materials/textures for the shared HELIX default set
--cell-size <meters>streaming cell size override

helix world scene-source compose

Compose a parent Scene that MOUNTS already-published child Scenes by content hash — no geometry, only pins

helix world scene-source compose [options] <plan>
ArgumentRequiredDescription
planyescompose plan JSON (see docs/scene-v2-mounts.md)
OptionDescription
-o, --output <dir>output directory for the composed Scene package (required)
--dry-runresolve and validate every mount without writing the package

helix world scene-source publish

Validate and dry-run the native Scene v2 World-build multipart request

helix world scene-source publish [options] <world-id> <package-dir>
ArgumentRequiredDescription
world-idyesowned World UUID
package-diryescompiled Scene v2 package directory
OptionDescription
--profile <id>Scene profile (default "world")
--content-rating <rating>everyone, teen, or mature (default "everyone")
--supports-mobiledeclare mobile support
--requires-authrequire an authenticated player
--visibility <visibility>private, unlisted, or public (default "private")
--publishupload the package and activate it as the World's build

helix world scene-elements

Compile nested typed architectural authoring data into native Scene v2

helix world scene-elements <command>

helix world scene-elements compile

Compile a helix.scene-elements/1 or /2 document, including exact pinned Devices, into sealed Scene v2

helix world scene-elements compile [options] <input>
ArgumentRequiredDescription
inputyessemantic scene-elements JSON file
OptionDescription
-o, --output <file>output .helix-scene.json file (required)

helix world audit

Run the blocking composition, bundle-budget, loader, and provenance audit

helix world audit [args...]
ArgumentRequiredDescription
args...noaudit options and paths

helix world performance-report

Analyze a built scene against existing Palette Showcase reference budgets, keep authored estimates separate from submitted runtime work, and print concrete optimization and verification guidance

helix world performance-report [options] [directory]
ArgumentRequiredDescription
directorynobuilt world bundle directory
OptionDescription
--scene <file>exact Scene v2 JSON for authoritative resource roles/integrity, surfaces, and stream groups
--package <file>Continuum Package version JSON for exact semantic material bindings and transitive closure facts
--snapshot <file>world inspect snapshot JSON for visible-scene triangles
--perf <file>supplied runtime performance receipt; byte/identity matches bind the claim but do not authenticate its origin
--profile <id>Palette Showcase reference profile (not a universal Scene budget) (default "web-desktop-balanced")
--jsonmachine-readable helix.scene-performance-report/1 output

helix world source-audit

Run the blocking lighting, materials, audio, mobile, and authority audit

helix world source-audit [args...]
ArgumentRequiredDescription
args...noaudit options and paths

helix world perf-gate

Measure real-GPU frame time and enforce the blocking performance budget

helix world perf-gate [args...]
ArgumentRequiredDescription
args...noaudit options and paths

helix world prove-live

Prove the deployed world matches the local published bundle

helix world prove-live [args...]
ArgumentRequiredDescription
args...noaudit options and paths

helix world inspect

Snapshot a built world headlessly and report layout anomalies: floating/sunk/intersecting geometry, collider-vs-visual divergence, stray transforms. Findings are measurements to check against your intent, not instructions to change the world.

helix world inspect [options] <dir>
ArgumentRequiredDescription
diryesthe built world bundle (usually the world's dist/)
OptionDescription
--report <sections>comma-separated sections: anomalies, roster, colliders, zones (default "anomalies")
--jsonmachine-readable output: { snapshot, analysis }
--out <file>also write the raw snapshot JSON (feed two of these to helix world diff)
--browser <key>force one launch candidate: bundled, chrome, or msedge (no fallback)
--settle-ms <n>settle time between helper-ready and the snapshot (default 750)
--max-objects <n>cap the object roster (truncation is always reported, never silent)
--timeout-ms <n>how long to wait for the in-page helper (default 60000)
--mount <prefix=dir>serve an extra dir at a URL prefix when the bundle itself 404s (repeatable; e.g. --mount /assets=<shared-asset-tree> for worlds that fetch a shared tree at the origin root) (default [])
--focus <substring>report only the objects whose path contains this (case-insensitive) — the single-object lens
--focus-near <x,y,z>report only the objects near this world-space point — check the thing you just placed without naming anything
--focus-radius <m>radius for --focus-near (default 2)
--baseline <file>the accepted-findings baseline to apply (default: inspect.baseline.json beside the world project — the dist dir's parent)
--no-baselineignore any baseline and report every finding
--show-acceptedrender baseline-accepted findings too, instead of hiding them behind the summary line
--write-baselineaccept the current findings wholesale into the baseline file — the one-time adjudication becoming durable

helix world metrics

Print the traversal/movement reference from the world's installed character system: capsule, step height, slope limit, jump envelope, clearances

helix world metrics [options]
OptionDescription
-C, --world <dir>the world project whose installed humanoid-character to read (must be npm-installed + helix install'd) (default ".")
--jsonmachine-readable output

helix world diff

Compare two saved snapshots: what moved and by how much, plus findings that appeared or cleared

helix world diff [options] <before> <after>
ArgumentRequiredDescription
beforeyessnapshot JSON from helix world inspect --out
afteryessnapshot JSON from a later helix world inspect --out
OptionDescription
--jsonmachine-readable output

On this page