Command Line Interface

You can run Wrap from the command line. To do that, go to the directory where Wrap is installed. Then type in the command line:

# for Windows
WrapCmd.exe [options] <command> [<args>]

# for Linux
./WrapCmd.sh [options] <command> [<args>]

Options

-?, -h, --help:: Display a list of supported options, commands, environment variables
-v, --version:: Display WrapCmd version
-l, --license:: Display details of the license state
-n, --nodes:: Display list of nodes in current WrapCmd
-f, --format:: Display current Wrap project file format version

Commands

compute:: Compute a frame range from the Wrap project
activateNodelocked:: Activate nodelocked license from a file
activateFloating:: Activate floating license by host and port

Type -?, -h or --help after a command name to get help on a specific command:

WrapCmd <command> --help

Command Error Codes

After the command is computed the process exits with one of the following codes:

Exit code 0	Success
Exit code 1	Invalid arguments
Exit code 2	Failed to compute
Exit code 3	Invalid license
Exit code 4	Failed to load a project to compute
Exit code >4	Other specified error

Before 2024.11 release codes differed:

Invalid submode arguments returned 2 instead of 1.
Computing with non-activated license returned 2 instead of 3.
Failed project loading returned 2 instead of 4.

Environment variables

WrapCmd supports gallery dir, license and OpenGL disabling variables. Check Environment Variables for details. To clarify exact flags type ./WrapCmd --help.

COMPUTE

Loads a project from a *.wrap file and computes the node-graph for specific frames. All Saving nodes will write data to files. All nodes with Auto-compute option will compute regardless of the option’s value. All errors will be printed in the standart output.

Syntax

WrapCmd compute <projectFile> [options...]

Arguments

projectFile:: a project *.wrap file path. If the path contains spaces please use double quotes.

Options

-s, --startFrame:: Sets the first frame of the rendering sequence. If not set, start frame is assumed to be 0
-e, --endFrame:: Sets the last frame of the rendering sequence. If not set, end frame is assumed to be equal to the start frame
-f, --frames:: Set the rendering sequence to custom frame range entered in a format 1,5,10-20. If using spaces be sure to add quotes: "1, 5, 10-20".
-i, --interactive:: Enters an interactive mode, awaiting for next frame number of range to be entered. Finishes on recieving exit input.
-m, --maxThreads:: Sets the max number of threads per process
-v, --verboseTimestamps:: If set, shows timestamps of begin and end of each node computation. Default value is defined by WRAPCMD_VERBOSE flag (or WRAP4DCMD_VERBOSE)
-w, --writingverbose:: If set, shows absolute filepaths of files written to the disk. Prints in format FILEWRITE "%node name%" "%filepath%".
-t, --timing:: If set, after each frame it prints a time of each node computation, arranges statistics and shows percentage per node.
--interactive:: If set, repeatedly waits for entering a frame number to compute in the standart input instead. Type exit to close interactive mode and exit.

Examples

WrapCmd compute "C:\Projects\Project.wrap"

Will compute the node-graph at frame 0.

wrapCmd compute "C:\Projects\Project.wrap" --startFrame 1

Will compute the node-graph at frame 1.

wrapCmd compute "C:\Projects\Project.wrap" -s 1 -e 7 -m 8

Will compute the node-graph starting from frame 1 to frame 7 with 8 threads at max.

wrapCmd compute "C:\Projects\Project.wrap" -f 1-10,20,25 -m 4

Will compute the node-graph starting from frame 1 to frame 10, frames 20 and 25, with 4 threads at max.

ACTIVATE NODELOCKED

WrapCmd activateNodelocked "C:\Licenses\Faceform_Node_License.lic"

ACTIVATE FLOATING

WrapCmd activateFloating 127.0.0.1 7308