config_reference.md

Command Line Utility Reference

Command Name	Description	Arguments
action	Execute the specified action with optional settings as a series of key=value pairs separated by commas	View 2 Arguments Arg Name Description Type Optional action_class Class name of the action to execute str No -s, --settings Settings for the action as a series of key=value pairs separated by commas str Yes
apply-pose	Apply the given named posed as pose file to the currently selected node or specified node	View 2 Arguments Arg Name Description Type Optional pose_file Absolute path to the pose file to be applied str No -t, --target-node Label of the node to apply the pose to. If not specified, apply to the currently selected node. str Yes
batch-render	Given a pattern of scene files, load each one and render it to the target location (default is studio-iray) with the given output file pattern	View 13 Arguments Arg Name Description Type Optional -s, --scene-files Pattern of scene files to load, including glob support. See README for examples str Yes -o, --output-path Path to directory where output files are to be written. If not specified, use the location of the scene file. str Yes -t, --target Target of the render. Allowed values are local-to-file, local-to-window, or iray-server-bridge str Yes -r, --resolution Resolution to render, overriding the resolution of the scene file, in WxH format (e.g. 1920x1080) str Yes -c, --cameras Cameras to render for. Can be one of 'all_visible', 'viewport', or a pattern that maps to one or more visible cameras str Yes -j, --job-name-pattern Pattern to use for naming job names or render output files. In the pattern, %s refers to the scene name, %c the camera name, %f the frame number, and %r the render count str Yes -f, --frames Frames to render. Comma-separated list of frames that can include ranges and range patterns. See README for full detail and example. str Yes --iray-server For target iray-server the IP address or hostname of the iRay server/master to use. str Yes --iray-protocol Sets the http protocol to use. Allowed values are http or https. str Yes --iray-port For target iray-server the TCP port of the iRay server/master. str Yes --iray-user For target iray-server the username to connect to the iRay server/master. Must be specified here or in config file specified by --iray-config-file str Yes --iray-password For target iray-server the password to connect to the iRay server/master. Must be specified here or in config file specified by --iray-config-file str Yes --iray-config-file For target iray-server the configuration options file to use for iRay server/master configuration. Values in this file can be overridden by additional command line arguments str Yes
copy-camera	Copy the specified camera (by label) to the specified target camera, or the current viewport camera if target not specified	View 2 Arguments Arg Name Description Type Optional -s, --source-camera Camera to copy from str Yes -t, --target-camera Camera to copy to (optional) str Yes
create-cam	Create a perspective camera with given name and camera type as parameters to generate the name of the camera along with the selected node label.	View 3 Arguments Arg Name Description Type Optional cam_name Name of the camera str No cam_class Class (type) of camera str No -f, --focus If true, turn DOF on the new camera flag (boolean) Yes
create-group	Group the selected nodes in the scene to the name specified.	View 1 Argument Arg Name Description Type Optional group_name Name of the new group. str No
drop-object	Drop one object on top of another, respecting bounding box boundaries.	View 2 Arguments Arg Name Description Type Optional source_node Label of the object to be dropped str No target_node Label of the object to be dropped onto str No
face-render-lora	Render a series of orbital camera angles around a figure's face for LoRA training image generation	View 8 Arguments Arg Name Description Type Optional -o, --output-dir Directory to write rendered images to. str Yes -p, --file-prefix Filename prefix for output images. Angle label and extension are appended. str Yes -W, --wid Render width in pixels. int Yes -H, --height Render height in pixels. int Yes -d, --camera-distance Camera distance from the face center in DAZ scene units (cm). int Yes -y, --face-y-offset Vertical offset from the head bone origin toward eye/nose level. int Yes -n, --node-label Label of the figure node to target. If not specified, the first skeleton in the scene is used. str Yes -t, --test-mode If set, show a message box at each angle instead of rendering. flag (boolean) Yes
help	Displays help information for commands.	View 1 Argument Arg Name Description Type Optional command_name The specific command to get help for. str Yes
inc-scene	Save the current scene file incrementing the file name with a numerical, incrementing, suffix.	View 2 Arguments Arg Name Description Type Optional -n, --number If specified, replace the numeric suffix at the end of the scene file name with the given number (or add it if one doesn't exist). int Yes -i, --increment If specified, increment the scene file suffix by the given amount (default = 1). int Yes
listproducts	Dump some basic product metadata for all products in the content management system to the specified output file.	View 1 Argument Arg Name Description Type Optional output_file Path to save output to str No
load-scene	Load the specified scene file, replacing the current scene if --merge is not used.	View 2 Arguments Arg Name Description Type Optional scene_file Path to scene file to load str No -m, --merge If specified, merge the new scene into the current scene instead of replacing. flag (boolean) Yes
lora-trainer-prep	Render a matrixed series of images suitable for LORA training.	View 2 Arguments Arg Name Description Type Optional scene_files A glob pattern that identifies the scene files to load. Each scene file should include a single model which has the hair and clothing applied str No lora_trainer_config Path to config file defining the render matrix of shots x poses x expressions str No
product-list	List the product information for objects in the current scene	View 3 Arguments Arg Name Description Type Optional -t, --target-file File to write output information to str Yes -n, --node-context If specified, present the output in the context of nodes. Otherwise the default is to present output in the context of products. flag (boolean) Yes -s, --selected-only Only identify products for the currently selected node. flag (boolean) Yes
rotate-random	Rotate and render the selected character.	View 2 Arguments Arg Name Description Type Optional object_name Label of the object to rotate prior to rendering str No lower Starting rotation (in degrees) int Yes
rotate-render	Rotate and render the selected character.	View 6 Arguments Arg Name Description Type Optional object_name Label of the object to rotate prior to rendering str No lower Starting rotation (in degrees) int Yes upper Ending rotation (in degrees). rotation-start must be smaller than rotation-end int Yes slices How many rotations between start and end to rotate. If set to zero, only render, do not rotate. int Yes -o, --output-file Absolute path to directory to render images in. Default is to generate one from the scene file name. str Yes -s, --skip-render Flag whether to render or the rotated character or not. Setting this flag skips the rendering step. flag (boolean) Yes
save-content-item	Save the selected items in the content library to the specified target location	View 1 Argument Arg Name Description Type Optional target_dir Location to save content item to str No
save-subset	Save the selected items to a scene subset file	View 3 Arguments Arg Name Description Type Optional subset_file Location to save content item to str No -d, --directory Directory to store the subset file in str Yes -c, --category Category to associate subset with str Yes
save-viewport	Capture and save the active viewport to image files for a range of frames	View 5 Arguments Arg Name Description Type Optional -f, --save-file Output file path root (without extension). Frame number and extension will be appended. str No -c, --view-camera Name of the camera to set in the viewport before capturing. If not specified, uses the current viewport camera. str Yes -e, --image-format Image file format/extension (e.g. png, jpg). Default is png. str Yes -s, --frame-start First frame to capture. Defaults to the current scene frame. int Yes -n, --frame-end End frame (exclusive) for capture range. Defaults to frame_start + 1 (single frame). int Yes
saveas	Make a copy of the current scene file to the specified location, simulating a Save As... function	View 1 Argument Arg Name Description Type Optional save_file Path to save a copy of the current scene file to str No
scene-render	Direct render the current scene, or a new scene file if specified, to the given output file.	View 2 Arguments Arg Name Description Type Optional -s, --scene-file Name of the scene file to load. str Yes -o, --output-file Path to output file to save to str Yes
transform-copy	Perform translate, rotate, and/or scale operations on target node to match the transforms on the target node.	View 6 Arguments Arg Name Description Type Optional source_node Node to translate from str No target_node Node to translate to str No -r, --rotate Apply the rotation transform flag (boolean) Yes -t, --translate Apply the translation transform flag (boolean) Yes -s, --scale Apply the scaling transform flag (boolean) Yes -a, --all Apply rotation, translation, and scaling trasforms flag (boolean) Yes