Usage:

rgworkflow [command] [options]

Options:
  --output <Human|Json>                                        The format used to write console output [default: Human]
  --log-file <None|FilePath>                                   Disable file logging or override default log file path
  --log-level <Debug|Error|Fatal|Information|Verbose|Warning>  The logging verbosity level [default: Information]
  -x, --non-interactive                                        Skip interactive prompts and proceed with default
  -y, --yes                                                    Respond 'yes' to non-interactive prompts
  -?, -h, --help                                               Show help and usage information
  --version                                                    Show version information

Commands:
  auth        Authenticate or log out from the Redgate licensing server
  run <path>  Execute a workflow json/yaml job or zip bundle

Running the help command rgworkflow run -h will give you help on the main run command used to run a workflow.

Description:
  Execute a workflow json/yaml job or zip bundle

Usage:
  rgworkflow run <path> [options]

Arguments:
  <path>  Path to the workflow file (yaml, json) or bundle (zip) to run

Options:
  --allow-scripts                                              Allow arbitrary user-scripts to run in the workflow
  --name <name>                                                Filename of the workflow to run in a .zip bundle
  --debug                                                      Debug mode does not clean up any failed steps or temporary files
  --dry-run                                                    Dry run mode does not execute any steps, only validates
  --warning-as-error                                           Treat warnings as errors which stop the workflow execution
  --output <Human|Json>                                        The format used to write console output [default: Human]
  --log-file <None|FilePath>                                   Disable file logging or override default log file path
  --log-level <Debug|Error|Fatal|Information|Verbose|Warning>  The logging verbosity level [default: Information]
  -x, --non-interactive                                        Skip interactive prompts and proceed with default
  -y, --yes                                                    Respond 'yes' to non-interactive prompts
  -?, -h, --help                                               Show help and usage information

Help command

Running the help command rgworkflow -h will give you help on general configuration.

Configuring where VHD Clones get deployed

To manage where VHD clones are placed while mounted, add the environment variable  TDM_VHD_CLONE_OUTPUT_DIR  to your system and point it at a path of your choosing.

Note that if you are using agents, it is recommended to pick an output directory at install time and not change it subsequently as this may cause older clones to break on reboot/reconnect.