Command Line Options

2023-01-01T00:41:32+00:00

Command Line Options

Options available to the application's Command Line Interface (CLI)

Usage: <executable_path> [-option[ <value>]] [filename]

Options:
- -resetDefaults
  - Causes all persistent application settings to be removed
- -noDefaultScene (since 4.0.2.29)
  - Suppresses loading of the Startup Scene (if specified)
- -logSize (since 4.9.4.61)
  - The <value> immediately following the option is used set the maximum size (in bytes) of the application log file
  - Supports k, m, g suffix
- -instanceName (since 4.12.1.19)
  - See Application Instancing
- -cleanOnLaunch (since 4.12.1.27)
  - See Application Instancing
- -cleanOnExit (since 4.12.1.26)
  - See Application Instancing
- -copyAppSettings (since 4.12.1.23)
  - The <value> immediately following the option is used as the name of the release cycle (and optionally the instance) to copy application settings from
  - The <value> must be quoted if it contains a space character
  - The <value> must match the suffix of the application settings group name for an instance that has been launched at least once (i.e., releaseCycle[instanceName])
    - Using the scripting environment, the return value of App.releaseCycleSuffixStripped() or App.releaseCycleInstanceSuffixStripped()
  - All spaces in the <value> are automatically stripped in order to match the pattern used in the application settings group name
  - A single “~” (tilde) character is interpreted as the root instance of the General Release
  - A single “.” (period) character is interpreted as the root instance of the 'current' release cycle
  - A non-existent instance name or a single unsupported character effectively disables the option (a match will be unable to be found)
  - All pertinent application settings are copied by default
  - A “;” (semi-colon) delimited whitelist can be used to limit copying to specific application settings
    - The first item in the list is used as the name of the release cycle (and optionally the instance) to copy application settings from
    - Subsequent items in the list represent the paths of specific application settings to copy
    - Specifying specific application settings overrides copying all application settings
- -copySessionUI (since 4.12.1.23)
  - The <value> immediately following the option is used as the name of the release cycle (and optionally the instance) to copy the session UI files from
  - The <value> must be quoted if it contains a space character (any besides the General Release will)
  - The <value> must match the suffix of the application data folder name for an instance that has been launched at least once (i.e., release cycle [instanceName])
    - Using the scripting environment, the return value of App.releaseCycleSuffix(), optionally appending App.instanceNameSuffix()
  - A single “~” (tilde) character is interpreted as the root instance of the General Release
  - A single “.” (period) character is interpreted as the root instance of the 'current' release cycle
  - A non-existent instance name or a single unsupported character effectively disables the option (a match will be unable to be found)
  - All session UI files are copied by default
  - A “;” (semi-colon) delimited whitelist can be used to limit copying to specific session UI files
    - The first item in the list is used as the name of the release cycle (and optionally the instance) to copy the session UI files from
    - Subsequent items in the list represent the names of specific session UI files to copy
    - Specifying specific session UI files overrides copying all session UI files
- -scriptArg (since 4.9.3.39)
  - The <value> immediately following the option is accessible to the scripting environment via the DzApp::scriptArgs array - i.e. App.scriptArgs[0]
  - Each successive -scriptArg <value> occurrence in the command line is available to the scripting environment as the (zero-based) i'th member of the DzApp.scriptArgs array - i.e. App.scriptArgs[1] for the value of the second occurrence, App.scriptArgs[2] for the value of the third occurrence, and so on
- -scriptArgsFile (since 4.9.3.105)
  - The <value> immediately following the option is the path of the file containing scriptArg entries
    - Must be quoted if it contains a space character
  - Each non-empty line in the file becomes an element in the DzApp::scriptArgs Array
  - Lines starting with the # (hash) character are ignored - comment

Experimental Options:
- -allowRemote (since 4.9.3.41)
  - Allows blocking of application launch due to incompatible OpenGL version detection to be bypassed
    - Useful for when the application is being launch using a remote desktop session, as the detected OpenGL version is typically too low even if the remote machine is known to be compatible when controlled locally
  - Does not prevent OpenGL version warning from being displayed
- -autoInstallMissing (since 4.15.0.16)
  - Automatically begins installation of products for “Missing Files” encountered during the asset loading process
  - Requires being logged in (via “Daz Connect”)
- -logMissingProduct (since 4.15.0.16)
  - Logs “Missing Products” encountered during the asset loading process
- -logModifiedAssets (since 4.15.1.68)
  - Logs asset information displayed in the “Save Modified Assets” dialog
- -noEmitLogMessages (since 4.16.1.26)
  - Suppresses emit of DzApp::fatalMessage(), DzApp::errorMessage(), DzApp::warningMessage(), DzApp::infoMessage(), DzApp::verboseMessage(), and DzApp::debugMessage() signals
- -noPrompt (since 4.9.3.39)
  - Intended to be used in conjunction with Application Instancing options, in an automation pipeline, when launching application instances (e.g., via DzProcess) to perform discrete tasks
    - Whether or not the application (instance) was launched with this option is accessible via DzApp::showPrompts()
      - Script: if( App.showPrompts() ){ … } else { … }
      - Plugin: if( dzApp→showPrompts() ){ … } else { … }
    - If a dialog is not discretely suppressed, the invocation of a (non-progress) dialog will cause the object name and class name of the dialog to be recorded to the application log, and the application to be closed
    - If a message box is not discretely suppressed, the invocation of a message will cause the message text to be recorded to the application log, and the application to be closed
    - Crash reports (BugTrap) auto-save to ./crashes folder
  - This feature is not strictly enforced and may not be fully implemented or necessarily respected by 3rd party plugins or scripts
- -headless (since 4.8.1.14)
  - Causes the application to be launched without a Graphical User Interface (GUI)
  - See DzApp::NoInterface, DzApp::getGraphicsMode()

Filename:
- The last argument that is not an option, or a valid argument to an option, is interpreted as the filename to open/merge (if any)
- The filename must be quoted if it contains a space character
- The filename may consist of a local file URI, using the file:// scheme (since 4.12.1.14)
  - The URI may include a query component
    - Each query item is available to the scripting environment as the (zero-based) i'th member of the DzApp.scriptArgs array - i.e. App.scriptArgs[0] for the first item, App.scriptArgs[1] for the second item, App.scriptArgs[2] for the third item, and so on
- Whether the file is opened or merged depends on the content type of the file

Documentation Center public:software:dazstudio:4:referenceguide:tech_articles:command_line_options

Command Line Options

Command Line Options