HELIX Docs
CLI & AI toolsCommand reference

helix item-def

Interactive item definitions — scaffold and validate a descriptor offline, then inspect an existing Package-backed definition

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

helix item-def

Interactive item definitions — scaffold and validate a descriptor offline, then inspect an existing Package-backed definition

helix item-def <command>

helix item-def scaffold

Emit a complete, publishable descriptor. Weapon: category archetype + engine spread/reload tables resolved in, default (or your own) sounds copied next to it. --type emote: the animation clip is the item — no mesh, no category, no gun config

helix item-def scaffold [options]
OptionDescription
--type <type>weapon | emote — the item type, which decides which flags below apply (default "weapon")
--mesh <file.glb>WEAPON: the prop mesh (grip at origin, +y up, +z out the barrel, meters)
--category <category>WEAPON: Rifle | Pistol | SMG | Shotgun | Sniper | LMG | Launcher | Grenade — inherits spread, reload foley, grip preset, shell class and fire kind
--sounds <dir>WEAPON: directory of your own .ogg shot sounds (mono opus-in-ogg; a file named dry becomes the dry-fire click)
--clip <file.glb>EMOTE: the animation GLB the emote plays
--playback <mode>EMOTE: oneshot | loop — a oneshot caps at 10s of clip, a loop at 60s (default "oneshot")
--audio <file.ogg>EMOTE: one .ogg the performance carries (mono opus-in-ogg)
--intro-clip <file.glb>EMOTE: the enter transition played into the clip (caps at 5s; not on a paired emote)
--outro-clip <file.glb>EMOTE: the exit transition played out of the clip (caps at 5s; not on a paired emote)
--title <name>item title, also the source of the item id (default: the mesh/clip basename)
--out <dir>output directory for the descriptor + copied files (default ".")

helix item-def validate

Validate a descriptor offline: the manifest authority validator, the vendored rules for its type (gun-config for a weapon, the emote block + measured clip duration for an emote), referenced-file existence, and the mesh precheck

helix item-def validate <file>
ArgumentRequiredDescription
fileyesthe .helix-interactive.json descriptor

helix item-def distribute

Create a Marketplace offer for an existing Package-backed Item

helix item-def distribute [options] <item-id>
ArgumentRequiredDescription
item-idyesthe Package-backed Item UUID (not a Vault assetId or a slug)
OptionDescription
--price <lix>listing price in LIX (default 500); positive prices must clear the per-kind floor
--claimlist free to claim (0 LIX)

helix item-def inspect

Resolve a published item definition and print what an author tunes against — a weapon's numbers, an emote's clip and playback

helix item-def inspect [options] <asset-ref>
ArgumentRequiredDescription
asset-refyesdefinition assetId, optionally @version (e.g. abc123@2)
OptionDescription
--jsonmachine-readable output (the raw descriptor + resolve metadata)

On this page