CLI & AI toolsCommand reference
helix device
Create, validate, and simulate GLB-backed HELIX Devices
CLI version 0.1.27-helix3.551. Run
helix device --help for the text your installed build prints.helix device
Create, validate, and simulate GLB-backed HELIX Devices
helix device <command>helix device create
Scaffold a helix.device/1 project around an existing GLB
helix device create [options] <directory>| Argument | Required | Description |
|---|---|---|
directory | yes | new Device project directory |
| Option | Description |
|---|---|
--id <slug> | stable Device definition id (required) |
--title <title> | player-facing Device title (required) |
--model <glb> | source GLB to copy into the project (required) |
--template <template> | standing-desk, clock, or television (default "standing-desk") |
helix device validate
Validate definition, GLB bytes/nodes, hosts, capabilities, state, and controls
helix device validate [options] [directory]| Argument | Required | Description |
|---|---|---|
directory | no | Device directory or device.json path |
| Option | Description |
|---|---|
--json | print the machine-readable report |
--room | also refuse state writes the room cannot run: any write reachable from an interact trigger through emitSignal, delay or branch (the backend applies this rule when sealing a new publish) |
helix device test
Run deterministic single-client and/or two-client authority simulations
helix device test [options] [directory]| Argument | Required | Description |
|---|---|---|
directory | no | Device directory or device.json path |
| Option | Description |
|---|---|
--mode <mode> | single, multiplayer, or both (default "both") |
--json | print machine-readable reports |