Command Line Arguments¶
Blender 2.93 Usage: blender [args …] [file] [args …]
Render Options¶
-b,--backgroundRun in background (often used for UI-less rendering).
-a,--render-animRender frames from start to end (inclusive).
-S,--scene<name>Set the active scene
<name>for rendering.-f,--render-frame<frame>Render frame
<frame>and save it.+<frame>start frame relative,-<frame>end frame relative.A comma separated list of frames can also be used (no spaces).
A range of frames can be expressed using
..separator between the first and last frames (inclusive).
-s,--frame-start<frame>Set start to frame
<frame>, supports +/- for relative frames too.-e,--frame-end<frame>Set end to frame
<frame>, supports +/- for relative frames too.-j,--frame-jump<frames>Set number of frames to step forward after each rendered frame.
-o,--render-output<path>Set the render path and file name. Use
//at the start of the path to render relative to the blend-file.The
#characters are replaced by the frame number, and used to define zero padding.animation_##_test.pngbecomesanimation_01_test.pngtest-######.pngbecomestest-000001.png
When the filename does not contain
#, The suffix####is added to the filename.The frame number will be added at the end of the filename, eg:
blender -b animation.blend -o //render_ -F PNG -x 1 -a//render_becomes//render_####, writing frames as//render_0001.png-E,--engine<engine>Specify the render engine. Use
-E helpto list available engines.-t,--threads<threads>Use amount of
<threads>for rendering and other operations [1-64], 0 for systems processor count.
Format Options¶
-F,--render-format<format>Set the render format. Valid options are:
TGARAWTGAJPEGIRISIRIZAVIRAWAVIJPEGPNGBMPFormats that can be compiled into Blender, not available on all systems:
HDRTIFFOPEN_EXROPEN_EXR_MULTILAYERMPEGCINEONDPXDDSJP2-x,--use-extension<bool>Set option to add the file extension to the end of the file.
Animation Playback Options¶
-a<options><file(s)>Instead of showing Blender’s user interface, this runs Blender as an animation player, to view movies and image sequences rendered in Blender (ignored if
-bis set).Playback Arguments:
-p<sx><sy>Open with lower left corner at
<sx>,<sy>.-mRead from disk (Do not buffer).
-f<fps><fps-base>Specify FPS to start with.
-j<frame>Set frame step to
<frame>.-s<frame>Play from
<frame>.-e<frame>Play until
<frame>.-c<cache_memory>Amount of memory in megabytes to allow for caching images during playback. Zero disables (clamping to a fixed number of frames instead).
Window Options¶
-w,--window-borderForce opening with borders.
-W,--window-fullscreenForce opening in fullscreen mode.
-p,--window-geometry<sx><sy><w><h>Open with lower left corner at
<sx>,<sy>and width and height as<w>,<h>.-M,--window-maximizedForce opening maximized.
-con,--start-consoleStart with the console window open (ignored if
-bis set), (Windows only).--no-native-pixelsDo not use native pixel size, for high resolution displays (MacBook
Retina).--no-window-focusOpen behind other windows and without taking focus.
Python Options¶
-y,--enable-autoexecEnable automatic Python script execution (default).
-Y,--disable-autoexecDisable automatic Python script execution (pydrivers & startup scripts).
-P,--python<filename>Run the given Python script file.
--python-text<name>Run the given Python script text block.
--python-expr<expression>Run the given expression as a Python script.
--python-consoleRun Blender with an interactive console.
--python-exit-code<code>Set the exit-code in [0..255] to exit if a Python exception is raised (only for scripts executed from the command line), zero disables.
--python-use-system-envAllow Python to use system environment variables such as
PYTHONPATHand the user site-packages directory.--addons<addon(s)>Comma separated list of add-ons (no spaces).
Logging Options¶
--log<match>Enable logging categories, taking a single comma separated argument. Multiple categories can be matched using a
.*suffix, so--log "wm.*"logs every kind of window-manager message. Sub-string can be matched using a*prefix and suffix, so--log "*undo*"logs every kind of undo-related message. Use “^” prefix to ignore, so--log "*,^wm.operator.*"logs all except forwm.operators.*Use “*” to log everything.--log-level<level>Set the logging verbosity level (higher for more details) defaults to 1, use -1 to log all levels.
--log-show-basenameOnly show file name in output (not the leading path).
--log-show-backtraceShow a back trace for each log message (debug builds only).
--log-show-timestampShow a timestamp for each log message in seconds since start.
--log-file<filename>Set a file to output the log to.
Debug Options¶
-d,--debugTurn debugging on.
Enables memory error detection
Disables mouse grab (to interact with a debugger in some cases)
Keeps Python’s
sys.stdinrather than setting it to None
--debug-value<value>Set debug value of
<value>on startup.--debug-eventsEnable debug messages for the event system.
--debug-ffmpegEnable debug messages from FFmpeg library.
--debug-handlersEnable debug messages for event handling.
--debug-libmvEnable debug messages from libmv library.
--debug-cyclesEnable debug messages from Cycles.
--debug-memoryEnable fully guarded memory allocation and debugging.
--debug-jobsEnable time profiling for background jobs.
--debug-pythonEnable debug messages for Python.
--debug-depsgraphEnable all debug messages from dependency graph.
--debug-depsgraph-evalEnable debug messages from dependency graph related on evaluation.
--debug-depsgraph-buildEnable debug messages from dependency graph related on graph construction.
--debug-depsgraph-tagEnable debug messages from dependency graph related on tagging.
--debug-depsgraph-no-threadsSwitch dependency graph to a single threaded evaluation.
--debug-depsgraph-timeEnable debug messages from dependency graph related on timing.
--debug-depsgraph-prettyEnable colors for dependency graph debug messages.
--debug-depsgraph-uuidEnable debug messages from dependency graph related on graph construction.
--debug-ghostEnable debug messages for event handling.
--debug-gpuEnable GPU debug context and information for OpenGL 4.3+.
--debug-gpu-force-workaroundsEnable workarounds for typical GPU issues and disable all GPU extensions.
--debug-wmEnable debug messages for the window manager, shows all operators in search, shows keymap errors.
--debug-xrEnable debug messages for virtual reality contexts. Enables the OpenXR API validation layer, (OpenXR) debug messages and general information prints.
--debug-xr-timeEnable debug messages for virtual reality frame rendering times.
--debug-allEnable all debug messages.
--debug-ioEnable debug messages for I/O (Collada, …).
--debug-fpeEnable floating-point exceptions.
--debug-exit-on-errorImmediately exit when internal errors are detected.
--disable-crash-handlerDisable the crash handler.
--disable-abort-handlerDisable the abort handler.
--verbose<verbose>Set the logging verbosity level for debug messages that support it.
Misc Options¶
--open-lastOpen the most recently opened blend file, instead of the default startup file.
--app-template<template>Set the application template (matching the directory name), use
defaultfor none.--factory-startupSkip reading the startup.blend in the users home directory.
--enable-event-simulateEnable event simulation testing feature
bpy.types.Window.event_simulate.--env-system-datafilesSet the
BLENDER_SYSTEM_DATAFILESenvironment variable.--env-system-scriptsSet the
BLENDER_SYSTEM_SCRIPTSenvironment variable.--env-system-pythonSet the
BLENDER_SYSTEM_PYTHONenvironment variable.-noaudioForce sound system to None.
-setaudioForce sound system to a specific device.
NoneSDLOpenALCoreAudioJACKPulseAudioWASAPI.-h,--helpPrint this help text and exit.
/?Print this help text and exit (Windows only).
-RRegister blend-file extension, then exit (Windows only).
-rSilently register blend-file extension, then exit (Windows only).
-v,--versionPrint Blender version and exit.
--End option processing, following arguments passed unchanged. Access via Python’s
sys.argv.
Other Options¶
--debug-freestyleEnable debug messages for Freestyle.
Argument Parsing¶
Arguments must be separated by white space, eg:
blender -ba test.blend
…will exit since -ba is an unknown argument.
Argument Order¶
Arguments are executed in the order they are given. eg:
blender --background test.blend --render-frame 1 --render-output '/tmp'
…will not render to /tmp because --render-frame 1 renders before the output path is set.
blender --background --render-output /tmp test.blend --render-frame 1
…will not render to /tmp because loading the blend-file overwrites the render output that was set.
blender --background test.blend --render-output /tmp --render-frame 1
…works as expected.
Environment Variables¶
- BLENDER_USER_CONFIG
Directory for user configuration files.
- BLENDER_USER_SCRIPTS
Directory for user scripts.
- BLENDER_SYSTEM_SCRIPTS
Directory for system wide scripts.
- BLENDER_USER_DATAFILES
Directory for user data files (icons, translations, ..).
- BLENDER_SYSTEM_DATAFILES
Directory for system wide data files.
- BLENDER_SYSTEM_PYTHON
Directory for system Python libraries.
- TEMP
Store temporary files here.
- TMP
or $TMPDIR Store temporary files here.