CLI commands¶

These tables list every script command accepted by the current Windows CLI. New scripts should use the current syntax. Deprecated aliases remain supported so existing scripts continue to run. Internal commands are shipped for RandomControl tooling and may change without notice.

Current syntax¶

Command and syntax	Status	Purpose
`apply_ambience <shelf>:<name>`	Preferred	Apply an ambience preset from a named shelf.
`apply_mannequin <file\\|none>`	Standard	Replace the matte mannequin from a `.webex`, or remove it.
`bake_mannequin`	Internal	Bake the `MEX_ANCHOR` mannequin marker for authoring.
`center_view`	Preferred	Re-center the camera without supplying a fake void value.
`clear_parts`	Standard	Remove all keyed multipart additions.
`draft_video`	Standard	Save a quick one-sample-per-frame animation as `.mp4`.
`exit`	Standard	End the script; the CLI appends it automatically.
`export_dressing [categories:]<file>`	Standard	Save selected or all scene-setting categories to `.webex_dressing`.
`get_property <node> <ustr>`	Preferred	Print one property from an explicit node or layer.
`import_dressing [categories:]<file>`	Standard	Apply selected or all categories from `.webex_dressing`.
`list_ambiences`	Standard	Print every available ambience as `shelf:name`.
`list_catalog_json`	Internal	Emit the library catalog and scene layers as framed JSON.
`list_layers`	Standard	Print the loaded scene's layers, grouped by family.
`list_materials`	Standard	Print every available library material.
`merge_part <id> <file>`	Standard	Add or atomically replace a keyed `.webex` or `.glb` part.
`nop`	Standard	Wait 64 frames before continuing.
`profile [turns]`	Internal	Run the render profiler for a positive number of turns.
`record_spinner`	Standard	Save a packaged 360-degree spinner.
`record_video`	Standard	Save a converged animation as `.mp4`.
`remove_part <id>`	Standard	Remove one keyed multipart addition.
`save_interactive`	Standard	Export a self-contained interactive `.webex`.
`save_static`	Standard	Export a regular `.webex`.
`set_layer_alias <layer>:<name>`	Standard	Rename an imported layer, auto-incrementing collisions.
`set_layer_family <layer>:<family>`	Standard	Reassign an imported layer's material family.
`set_material <layer> <material>`	Preferred	Apply a material; quote a layer name containing spaces.
`set_property <ustr> <value>`	Preferred	Set a property, inferring its node from the USTR prefix.
`set_property <node> <ustr> <value>`	Preferred	Set a property on an explicit node or layer; use this when the node cannot be inferred.
`take_atlas`	Standard	Save a multi-viewpoint atlas contact sheet.
`take_picture`	Standard	Save a converged still image as `.jpg`.
`take_picture_alpha`	Internal	Save the internal transparent product cutout as `.png`.
`validate_webex_decode <file>`	Internal	Run the internal WebEx mesh-decoder parity check.

Deprecated syntax¶

Deprecated command and syntax	Current replacement	Notes
`apply_amb <shelf>:<name>`	`apply_ambience <shelf>:<name>`	Legacy ambience alias.
`apply_material <layer>:<material>`	`set_material <layer> <material>`	Legacy colon-separated material syntax.
`apply_mtl <layer>:<material>`	`set_material <layer> <material>`	Older shorthand for `apply_material`.
`set <ustr> <value>`	`set_property <ustr> <value>`	Exact alias; behavior and node inference are identical.
`set_string <node> <ustr> <value>`	`set_property <node> <ustr> <value>`	Exact explicit-node compatibility alias.

set_property recognizes the globals_, dressing_, animation_, camera_, and render_pipeline_ prefixes. An arbitrary layer property such as obj_visible has no node encoded in its USTR, so use the explicit-node overload:

set_property "Metal Band" obj_visible 0

See the CLI guide for installation, flags, scripts, outputs, exit codes, and complete recipes.