HELIX CLI
Scaffold, validate, and publish HELIX worlds and items from the terminal — the same commands humans and AI agents use.
@hypersoniclabs/helix-cli is the front door for building on HELIX. It scaffolds world projects,
resolves the systems and abilities a world pins, validates a bundle against the exact rules the
server enforces, and publishes both worlds (play-from-a-link browser games) and items
(wearables, avatars, home items).
npm install -g @hypersoniclabs/helix-cli
# or, always current: npx -y @hypersoniclabs/helix-cli <command>The binary is `helix`, the package is scoped
Install the scoped package — a bare npx helix resolves to an unrelated package on npm. A global
install goes stale; npx -y @hypersoniclabs/helix-cli@latest is always current, and helix doctor
tells you when anything in the toolchain is behind.
Account
Prop
Type
Worlds
Prop
Type
Typical loop
npx -y @hypersoniclabs/helix-cli init my-world
cd my-world && npm install
helix install # resolve the pinned systems/abilities
npm run build # your project's build → dist/
helix validate dist # catch problems before the server does
helix publish dist # ship a build, get a play linkItems
An item is published from a single .glb — no bundle, no build. See
Publish a wearable for the full walkthrough.
Prop
Type
Assets and inspection
Prop
Type
Catalog
Prop
Type
Run helix <command> --help for the complete flag list — the CLI's own help ships with the build you
have installed, so it is the authority on the version in your hands.
Auto-generated reference
The docs pipeline runs on every merge to main:
The Web SDK reference is generated from the @hypersoniclabs/helix-sdk TypeScript source with
TypeDoc.
The Unreal SDK reference is generated from the Unreal plugin headers with Doxygen, then mapped to Blueprint / Lua.
The /llms.txt index and /llms-full.txt bundle are rebuilt, and the
site is deployed.
This is what keeps Web reference and
Unreal reference in sync with shipped code. See the repo's
.github/workflows/deploy.yml and CONTRIBUTING.md for the exact pipeline.
For AI agents
Agents drive the same code paths through the MCP server, which exposes discovery, validation, world publishing and item publishing as typed tools.
Sell an item for LIX
Add a server-authoritative, idempotent in-world purchase. The client requests; the server charges LIX and grants the item atomically.
Publish a wearable
Upload a garment or accessory from a .glb with helix item publish — the Character-Creator slot and gender are required, and the server verifies the mesh inline.