HELIX Docs
CLI & AI toolsCommand reference

helix assets

Discover, install, and generate HELIX platform assets

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

helix assets

Discover, install, and generate HELIX platform assets

helix assets <command>

helix assets credits

Render ASSET-CREDITS.md from the world provenance table

helix assets credits [args...]
ArgumentRequiredDescription
args...noaudit options and paths

helix assets check-loaders

Reject GLTF assets that require unsupported Draco or meshopt loaders

helix assets check-loaders [args...]
ArgumentRequiredDescription
args...noaudit options and paths

helix assets materials

Search the versioned HELIX material catalog

helix assets materials [options]
OptionDescription
-q, --query <text>search id, name, category, and tags
--category <category>exact material category
--limit <n>maximum results
--resolution <res>keep only materials carrying this texture resolution, e.g. 1k or 2k (1024/2048 also accepted)
--no-resolveskip the Vault and Continuum pin lookups — emit the derived package id only
--include-unlistedalso list materials the tools do not offer (procedural, generated, unbuilt)
--humanreadable summary instead of JSON

helix assets material

Resolve one material id to its immutable map URLs

helix assets material [options] <id>
ArgumentRequiredDescription
idyesmaterial id from helix assets materials
OptionDescription
--resolution <res>texture resolution, e.g. 1k or 2k (1024/2048 also accepted); omit for the default
--no-resolveskip the Vault and Continuum pin lookups — emit the derived package id only
--include-unlistedresolve a material the tools do not offer (procedural, generated, unbuilt)
--humanreadable summary instead of JSON

Search reusable HELIX Vault assets

helix assets search [options] [query]
ArgumentRequiredDescription
querynofree-text search
OptionDescription
--match <mode>what the query does: recall (rank, never empty) or narrow (filter)
--kind <a,b>comma-separated kinds (prop, character, animation, audio, texture, material, environment, terrain, vfx, decal, sky, gaussian_splat, scene, interactive_item, unreal_package)
--subtype <type>typed subtype, e.g. static-prop or pbr-material
--scope <scope>Gaussian-splat scope: object or environment
--format <format>primary artifact format, e.g. glb, spz, hdr, or helix-material
--performance-tier <tier>mobile, desktop, cinematic, or unknown
--rank <mode>relevance, performance, or reuse (default "relevance")
--skeleton <id>required skeleton
--engine <engine>target engine
--license <license>license filter
--source <source>source filter
--origin <origin>origin/provenance filter
--creator-id <id>creator id
--officialonly platform-vouched (official) assets — the calibrated tier; try it first and widen when it has no fit
--no-officialonly community assets — the complement of --official
--page <n>page number
--limit <n>page size

helix assets get

Read one HELIX Vault asset

helix assets get <asset-id>
ArgumentRequiredDescription
asset-idyesVault asset UUID

helix assets versions

List immutable versions of one HELIX Vault asset

helix assets versions <asset-id>
ArgumentRequiredDescription
asset-idyesVault asset UUID

helix assets track

Read measured Vault usage for one durable asset id

helix assets track <asset-id>
ArgumentRequiredDescription
asset-idyesVault asset UUID

helix assets update

Update Vault annotations without changing immutable artifact bytes

helix assets update [options] <asset-id>
ArgumentRequiredDescription
asset-idyesVault asset UUID
OptionDescription
--title <title>replacement display title
--description <text>replacement description
--clear-descriptionclear the description
--tags <a,b>replacement comma-separated tag set
--content-rating <rating>everyone, teen, mature, or adult
--accept-rating-attestationattest that the replacement content rating is accurate

helix assets install

Install one checksum-protected Vault artifact version into a world and write its provenance receipt

helix assets install [options] <asset-id>
ArgumentRequiredDescription
asset-idyesVault asset UUID
OptionDescription
-C, --world <dir>world project directory (default ".")
--asset-version <n>exact immutable Vault version
--checksum-sha256 <hex>expected SHA-256 for the exact version
--size-bytes <n>expected byte size for the exact version
--material-renditions <runtime|source|all>material map family: runtime KTX2 only (default), source PNG only, or all (default "runtime")

helix assets start

Start one generation job without waiting; prop/character use the Asset Generation job lane, other supported kinds use the standalone lane. For audio, --mode selects sound_effect (default), music, or text_to_speech.

helix assets start [options] <kind> [prompt]
ArgumentRequiredDescription
kindyesprop, character, image, material, audio, gaussian_splat, or animation (explicit unavailable stub)
promptnoasset prompt (sound_effect/music/other kinds; speech uses --text)
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--target-polycount <n>prop/character triangle target
--project-id <id>Dreamer project id (set only when Dreamer, the website agent, started the call)
--session-id <id>Dreamer session id (set only when Dreamer, the website agent, started the call)
--loopaudio: request loopable output
--duration-seconds <n>audio duration
--resolution <n>material resolution: 1024 or 2048 (default "1024")
--repeat-per-meter <n>material physical scale: tile repeats per metre
--splat-scope <scope>Gaussian-splat scope: object or environment (default "environment")
--visibility <visibility>character: public, unlisted, or private. Sent only when you pass it; otherwise the Asset Generation job driver applies its own default
--reference-review-seconds <n>character: seconds the reference sheet waits for a look before it auto-approves (0-120). Unattended runs (an agent) should set it; without it the sheet waits for a person
--idempotency-key <key>character: re-attach to the job a previous start created instead of creating a second (8-96 characters). Default: a fresh key, printed so a start whose answer was lost can be re-run safely
--max-lix <n>refuse to start if the estimate exceeds this many LIX
--no-estimateskip the up-front cost estimate
--mode <mode>sound_effect, music, or text_to_speech (default "sound_effect")
--model <model>an allowlisted ElevenLabs model id for the selected --mode
--output-format <format>portable MP3 output format, e.g. mp3_44100_128
--prompt-influence <n>sound_effect only: how closely to follow the prompt (0-1)
--force-instrumentalmusic only: request an instrumental-only composition
--text <text>text_to_speech only: the text to convert to speech
--voice-id <id>text_to_speech only: the voice id to speak with (see helix assets voices)
--language-code <code>text_to_speech only: ISO 639-1 language code
--seed <n>text_to_speech only: a seed for deterministic output
--stability <n>text_to_speech only: voice stability (0-1)
--similarity-boost <n>text_to_speech only: voice similarity boost (0-1)
--style <n>text_to_speech only: voice style (0-1)
--speed <n>text_to_speech only: voice speed (0.7-1.2)
--speaker-boosttext_to_speech only: enable speaker boost
--pronunciation-dictionary-ids <a,b,c>text_to_speech only: up to 3 comma-separated pronunciation dictionary ids

helix assets estimate

Price a generation BEFORE running it — itemized per stage (mesh, texture, rigging), from the same quote the charge is made against

helix assets estimate [options] <kind> <prompt>
ArgumentRequiredDescription
kindyesprop, character, image, material, audio, or gaussian_splat
promptyesasset prompt
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--target-polycount <n>prop/character triangle target
--resolution <n>material resolution: 1024 or 2048
--duration-seconds <n>audio duration
--audio-mode <mode>sound_effect, music, or text_to_speech
--voice-id <id>text_to_speech voice id
--text <text>text_to_speech content
--splat-scope <scope>gaussian-splat scope: object or environment
--no-balanceskip the balance lookup (estimate only)
--jsonemit the raw quote

helix assets approve

Approve a job waiting at an approval gate. The concept gate continues on its own; the preview gate then waits for helix assets resume

helix assets approve [options] <job-id>
ArgumentRequiredDescription
job-idyesAsset Generation job id
OptionDescription
--gate <gate>concept or preview (required)
--jsonemit only the job JSON on stdout

helix assets revise

Revise a job waiting at an approval gate, with new guidance. CHARGES a fresh regeneration — this is a spend, not a free retry. The only advance path when the server rejected its own concept.

helix assets revise [options] <job-id>
ArgumentRequiredDescription
job-idyesAsset Generation job id
OptionDescription
--gate <gate>concept or preview (required)
--prompt <text>what to change about the rejected output

helix assets retry

Retry a FAILED job (no new guidance). Resumes from the stage that stopped — the mesh phase for a prop or character, the bundle/publish step for a material, image or texture

helix assets retry <job-id>
ArgumentRequiredDescription
job-idyesAsset Generation job id

helix assets abandon

Explain how a stranded job releases its held LIX (no platform verb does this on demand)

helix assets abandon [job-id]
ArgumentRequiredDescription
job-idnoAsset Generation job id

helix assets status

Poll one generation job without starting or advancing a duplicate

helix assets status [options] <job-id>
ArgumentRequiredDescription
job-idyesAsset Generation job id
OptionDescription
--pipeline <pipeline>driver = a character driven by the Asset Generation job driver (start character), dreamer = prop/legacy character job lane (legacy name), asset = standalone lane (required)

helix assets start-reference

Start a character job from a trusted four-view reference sheet without invoking image generation

helix assets start-reference [options] <reference-sheet> <prompt>
ArgumentRequiredDescription
reference-sheetyesPNG, JPEG, or WebP FRONT/BACK/LEFT/RIGHT sheet
promptyescharacter prompt
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--target-polycount <n>target triangle count

helix assets generate

Generate and publish a new prop or character with Asset Generation

helix assets generate [options] <kind> <prompt>
ArgumentRequiredDescription
kindyesprop or character
promptyesasset prompt
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--target-polycount <n>target triangle count
--visibility <visibility>public, unlisted, or private (default public for a prop; a character uses the Asset Generation job driver default unless you pass it)
--timeout <ms>how long to wait for the job to finish before giving up (client-side only — the job keeps running; default 20min for a prop, 80min for a character)
--poll-interval <ms>how often to poll job status while waiting (default 2000ms prop, 3000ms character)
--reference-review-seconds <n>character: seconds the reference sheet waits for a look before it auto-approves (0-120). Unattended runs (an agent) should set it; without it the sheet waits for a person
--idempotency-key <key>character: re-attach to the job a previous start created instead of creating a second (8-96 characters). Default: a fresh key, printed so a start whose answer was lost can be re-run safely
--max-lix <n>refuse to start if the estimate exceeds this many LIX
--no-estimateskip the up-front cost estimate

helix assets generate-reference

Generate, rig, preview, and publish a character from a trusted four-view reference sheet

helix assets generate-reference [options] <reference-sheet> <prompt>
ArgumentRequiredDescription
reference-sheetyesPNG, JPEG, or WebP FRONT/BACK/LEFT/RIGHT sheet
promptyescharacter prompt
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--target-polycount <n>target triangle count
--visibility <visibility>public, unlisted, or private (default "public")
--timeout <ms>how long to wait for the job to finish before giving up (client-side only — the job keeps running; default 1200000ms/20min)
--poll-interval <ms>how often to poll job status while waiting (default 2000ms)

helix assets resume

Wait for an Asset Generation job and print its result. A character started with helix assets start character is driven by the server: this only reads it (progress lines on stderr, the job JSON on stdout; exit 0 for succeeded/held/handoff, 1 for failed or a client timeout). Older job ids (props, legacy characters) resume and publish through the previous loop

helix assets resume [options] <job-id>
ArgumentRequiredDescription
job-idyesAsset Generation job id
OptionDescription
--visibility <visibility>public, unlisted, or private (legacy jobs: default is the visibility the job was generated with, else public). A driver job fixes its visibility when it starts: a different value here is an error
--timeout <ms>how long to wait for the job to finish before giving up (client-side only — the job keeps running; default 80min for a driver job, 20min for a legacy job)
--poll-interval <ms>how often to poll job status while waiting (default 3000ms driver job, 2000ms legacy job)

helix assets act

Decide at the open reference gate of an Asset Generation job driven by the server: approve it now, or revise it with guidance (a revise charges a regeneration)

helix assets act [options] <job-id> <action> [guidance]
ArgumentRequiredDescription
job-idyesAsset Generation job id
actionyesapprove or revise
guidancenorevise: what to change
OptionDescription
--prompt <text>revise: what to change (same as the guidance argument)

helix assets refund

Get the LIX back for an avatar the platform check held (Asset Generation job driver; server-verified, idempotent)

helix assets refund <job-id>
ArgumentRequiredDescription
job-idyesAsset Generation job id

helix assets generate-image

Generate a standalone image with Asset Generation

helix assets generate-image [options] <prompt>
ArgumentRequiredDescription
promptyesimage prompt
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--project-id <id>Dreamer project id (set only when Dreamer, the website agent, started the call)
--session-id <id>Dreamer session id (set only when Dreamer, the website agent, started the call)
--visibility <public|private>where the image lands in the Vault. Default: your account preference (public unless you opted out). Use private for the concept/reference sheet of a private avatar, so the sheet is not published.

helix assets generate-material

Generate a validated portable PBR material bundle and auto-publish it to Vault

helix assets generate-material [options] <prompt>
ArgumentRequiredDescription
promptyesmaterial prompt
OptionDescription
--title <title>asset title
--additional-prompt <text>additional generation guidance
--project-id <id>Dreamer project id (set only when Dreamer, the website agent, started the call)
--session-id <id>Dreamer session id (set only when Dreamer, the website agent, started the call)
--resolution <n>map resolution: 1024 (web/mobile default) or 2048 (default "1024")
--repeat-per-meter <n>physical texture scale expressed as tile repeats per metre

helix assets generate-environment

Generate an experimental Gaussian-splat environment with Asset Generation

helix assets generate-environment [options] <prompt>
ArgumentRequiredDescription
promptyesgeneration prompt
OptionDescription
--additional-prompt <text>additional generation guidance
--project-id <id>Dreamer project id (set only when Dreamer, the website agent, started the call)
--session-id <id>Dreamer session id (set only when Dreamer, the website agent, started the call)
--title <title>asset title
--splat-scope <scope>object or environment (default "environment")

helix assets generate-audio

Generate a sound effect, music track, or spoken line via ElevenLabs (with Asset Generation), auto-publish it to Vault, and optionally save it locally. Blocks until done — use helix assets start audio for a pollable job.

helix assets generate-audio [options] [prompt]
ArgumentRequiredDescription
promptnogeneration prompt — required for sound_effect/music; text_to_speech uses --text instead
OptionDescription
--mode <mode>sound_effect, music, or text_to_speech (default "sound_effect")
--additional-prompt <text>additional generation guidance
--model <model>an allowlisted ElevenLabs model id for the selected --mode
--output-format <format>portable MP3 output format, e.g. mp3_44100_128
--project-id <id>Dreamer project id (set only when Dreamer, the website agent, started the call)
--session-id <id>Dreamer session id (set only when Dreamer, the website agent, started the call)
--title <title>asset title
--duration-seconds <n>requested duration — sound_effect: 0.5-30s; music: 3-600s
--loopsound_effect only: request a seamless loop
--prompt-influence <n>sound_effect only: how closely to follow the prompt (0-1)
--force-instrumentalmusic only: request an instrumental-only composition
--text <text>text_to_speech only: the text to convert to speech
--voice-id <id>text_to_speech only: the voice id to speak with (see helix assets voices)
--language-code <code>text_to_speech only: ISO 639-1 language code
--seed <n>text_to_speech only: a seed for deterministic output
--stability <n>text_to_speech only: voice stability (0-1)
--similarity-boost <n>text_to_speech only: voice similarity boost (0-1)
--style <n>text_to_speech only: voice style (0-1)
--speed <n>text_to_speech only: voice speed (0.7-1.2)
--speaker-boosttext_to_speech only: enable speaker boost
--pronunciation-dictionary-ids <a,b,c>text_to_speech only: up to 3 comma-separated pronunciation dictionary ids
--output <path>save the generated audio file to this path

helix assets voices

List or search HELIX text-to-speech voices

helix assets voices [options]
OptionDescription
--search <text>search name, description, labels, and category
--category <category>premade or professional
--page-size <n>voices per page (1-100) (default "20")
--page-token <token>opaque token printed by the previous page
--jsonprint the complete machine-readable catalog response

On this page