1.2 Blender 3D Command Line Interface¶
To get a list of Blender command line options, use the “ccl –templateShow Blender” command. For example:
> ccl --templateShow Blender
Usage: Blender <options> ...
General options Mandatory Description
----------------------------------------------------------------------------------------------------------------------------------------
--appProfile <profile-name> Yes Application profile selection.
--batchId <batch-id> - Batch Id.
--deliveryMethod <method> - Delivery method.
--endFrame <frame-number> Yes Job end frame.
--extraAppOptions <application-options> - Extra application options.
--frameList <frame-list> - Frame list.
--framePerSlice <frames-per-slice> - Frames per slice.
--gpuExcludeList <gpu-model-list> - GPU exclusion list.
--gpuIncludeList <gpu-model-list> - GPU inclusion list.
--jobDescription <description> - Job description.
--jobId <job-id> Yes Job identifier..
--maxCpuSlices <max-cpu-slices> - Maximum CPU slices.
--maxGpuSlices <max-gpu-slices> - Maximum GPU slices.
--outputFolder <output-path> Yes Output folder.
--pool <profile-name> Yes Render pool.
--projectFolder <folder-path> Yes Project folder path.
--renderPluginsUsed <plugin-list> - Application render plugins used.
--renderQueue <render-queue> Yes Render queue.
--rootProjectFolder <root-project-path> - Root Project Folder.
--sceneFile <scene-filename> Yes Relative scene file name.
--sceneName <scene-name> Yes Name of scene or shot.
--startFrame <frame-number> Yes Job start frame.
--stepFrame <frame-step> - Job step frame.
--template <template-name> Yes Use supported template.
--videoEncoder <encoder> - Video encoder (h.264, h.265, vpx-vp9 etc...).
--videoFormat <format> - Video file format.
--videoFrameRate <frame-rate> - Video frame rate.
--videoOutputDir <output-path> - Video output dir.
--videoQuality <quality> - Video quality (0-51: 0:lossless 51:worst).
--videoResolution <resolution> - Video resolution.
--vmCreationCount <vm-count> - VM creation count.
--vmInstancePrefix <prefix> - VM prefix for instances (max 10 chars).
--vmProfileName <profile-name> - VM profile to use.
Application specific options Mandatory Description
----------------------------------------------------------------------------------------------------------------------------------------
--bakeJob - Bake job.
--cpuRenderer <cpu-renderer> - CPU Renderer.
--gpuRenderer <gpu-renderer> - GPU Renderer.
--imageFormat <format> Yes Image format.
--imageHeight <height> - Image height.
--imagePrefix <prefix> Yes Image prefix.
--imageWidth <width> - Image width.
--renderEngine <render-engine> - Rendering engine.
--tileAuto <mode> - Tile render auto-mode.
--tileCols <num-of-cols> - Tile render cols.
--tileRenderer <renderer-name> - Tile render engine to use.
--tileRows <num-of-rows> - Tile render rows.
--tileSubmit <true> - Submit tile render jobs.
--useGpu - Use GPU for rendering.
"--imageFormat" options: BMP,IRIS,IRIZ,PNG,JPEG,JPEG2000,JP2,TGA,RAWTGA,CINEON,DPX,OPEN_EXR_MULTILAYER,OPEN_EXR,HDR,TIFF
"--renderEngine" options: BLENDER_EEVEE,CYCLES
"--gpuRenderer" options: Redshift,ProRender,CYCLES,octane,eevee
To submit a simple CPU request, issue the follow command:
> ccl --submitJob --template blender --appProfile BLENDER_2.93.4 --projectFolder E:\svn\sceneContent\BlenderScenes\bmw --sceneFile bmw27_gpu.blend --outputFolder E:\tmp --sceneName default --jobId blender_cpu_test_job --startFrame 1 --endFrame 10 --pool NETWORK --renderQueue "PRIORITY 10" --deliveryMethod frame --framePerSlice 1 --imagePrefix blender-verify- --imageFormat png
To submit a simple GPU request using the CYCLES GPU render engine, issue the follow command:
> ccl --submitJob --template blender --appProfile BLENDER_2.93.4 --projectFolder E:\svn\sceneContent\BlenderScenes\bmw --sceneFile bmw27_gpu.blend --outputFolder E:\tmp --sceneName default --jobId blender_gpu_test_job --startFrame 1 --endFrame 10 --pool NETWORK --renderQueue "PRIORITY 10" --deliveryMethod frame --framePerSlice 1 --imagePrefix blender-verify- --imageFormat png --gpuRenderer CYCLES --useGpu --renderEngine CYCLES
Last Updated on 2021-12-15
