Nuke Environment Variables

The following table lists the environment variables Nuke recognizes.

Environment Variable

Description

FN_CRASH_DUMP_PATH

Allows you to specify where Issue Reporter dumps are saved by default.

FN_DISABLE_LICENSE_DIALOG

or

FN_NUKE_DISABLE_TMPLIC_NOTIFY_DIALOG

By default, if you have installed a temporary license, Nuke displays a dialog at start-up alerting you to the number of days remaining. If you want to disable this behavior, you can set either of these environment variables to 1 to suppress the warning message about imminent license expiration.

NOTE:  You still get a warning if no license is found, for example if you only have a Nuke license but you try to run NukeX.

FN_LICENSE_DIALOG_DAYS_LEFT_BEFORE_PROMPT

By default, if you have installed a temporary license, Nuke displays a dialog at start-up alerting you to the number of days remaining. If you want to disable this behavior until a set number of days before expiry, you can set this environment variables to the required number of days.

NOTE:  You still get a warning if no license is found, for example if you only have a Nuke license but you try to run NukeX.

FN_NUKE_DISABLE_GPU_ACCELERATION

This variable disables Nuke's CUDA and OpenCL capabilities. When enabled, any GPUs installed locally are disabled and cannot be selected from Preferences > Performance > Hardware > default blink device dropdown. Any GPU accelerated nodes, such as Kronos and Denoise, default to processing on the CPU.

FN_SUBSCRIPTION_LICENSE_DIR

On Windows, user names containing non-ASCII characters can cause subscription licensing to fail. If a licensing error similar to the following displays:

Unable to create subscription license directory: C:\Users\Zoë Hernández\FoundryLicensing\

Try changing the license directory to an alternate location using this environment variable.

foundry_LICENSE

The location of the Nuke RLM license file, if the following recommended location is not used:

On Mac OS X and Linux:

/usr/local/foundry/RLM

On Windows:

drive letter:\Program Files\The Foundry\RLM

NOTE:  We're in the process of migrating licenses from FLEXlm to the RLM licensing model. If you're interested in making an early move to RLM licensing, please contact sales@thefoundry.co.uk to obtain a replacement license.

FOUNDRY_LICENSE_DEBUG

This variable prints additional licensing information to the command line or Terminal.

FOUNDRY_LICENSE_FILE

The location of the Nuke FLEXlm license file, if the following recommended location is not used:

On Mac OS X and Linux:

/usr/local/foundry/FLEXlm

On Windows:

drive letter:\Program Files\The Foundry\FLEXlm

NOTE:  We're in the process of migrating licenses from FLEXlm to the RLM licensing model. If you're interested in making an early move to RLM licensing, please contact sales@thefoundry.co.uk to obtain a replacement license.

FOUNDRY_LOG_FILE

This variable specifies the location of Nuke’s logfile. If you don’t specify a logfile, all output is to screen.

FOUNDRY_LOG_LEVEL

This variable sets the level of logging Nuke produces during operation. There are four levels of detail, on a sliding scale from minimal to verbose:

error

warning

message

verbose

NOTE:  Setting the logging level to verbose can produce large log files when FOUNDRY_LOG_FILE is specified.

FRAMESERVER_LOG_DIR

This variable is used to specify a different location for the Frame Server to write log files to, if you'd like to keep them separate from the default NUKE_TEMP_DIR.

See Using Nuke Studio's Frame Server for more information.

HIERO_DISABLE_THUMBNAILS

Set this variable to stop Nuke Studio loading thumbnails.

HIERO_DISABLE_THUMBNAILS_CACHE

Set this variable to stop Nuke Studio caching thumbnails for improved access once loaded.

NOTE:  This variable does not clear the cache, you must remove cached files manually.

NUKE_AJA_CHANNEL

AJA cards take 3G level signal (mostly for 12-bit 444 RGB) and combine it into a single 3G-B (B denotes B level, hence the 3G-B) stream through SDI1 by default. Use these environment variables to customize this output behavior:

NUKE_AJA_CHANNEL - set this variable to 2, 3, or 4 to output a single stream through SDI2, SDI3, or SDI4.

NUKE_AJA_DUALOUTPUT - set this environment variable to 1 to force the card to separate the single 3G stream into two 1.5G streams through SDI1 and SDI2.

Combining these two environment variables can force the stream to split and output through alternate SDI outputs. For example:

DUALOUTPUT + CHANNEL=1 OR CHANNEL=2 results in two 1.5G streams coming from SDI1 and SDI2.

DUALOUTPUT + CHANNEL=3 OR CHANNEL=4 results in two 1.5G streams coming from SDI3 and SDI4.

NOTE:  Certain modes, such as 12-bit 444, require a 3G stream. Otherwise, the card uses the single stream on the channel number specified.

NUKE_AJA_DUALOUTPUT

NUKE_ALLOW_GIZMO_SAVING

Nuke does not allow you to Overwrite and Save as gizmos by default, without copying the gizmo to a Group. Setting this environment variable to 1 enables this behavior, so artists don't need to copy a gizmo before editing it.

NUKE_CRASH_HANDLING

Breakpad crash reporting allows you to submit crash dumps to The Foundry in the unlikely event of a crash. By default, crash reporting is enabled in GUI mode and disabled in terminal mode.

When NUKE_CRASH_HANDLING is set to 1, crash reporting is enabled in both GUI and terminal mode.

When NUKE_CRASH_HANDLING is set to 0, crash reporting is disabled in both GUI and terminal mode.

NUKE_DEBUG_IMAGECACHE

When enabled, Comp Viewer image cache data is printed to the command line or Terminal. Information on disk space used, the number of files cached, and the cache location is displayed.

NUKE_DEBUG_MEMORY

When working on large images, Nuke may need to free up memory during rendering. When this happens and NUKE_DEBUG_MEMORY is set to 1, Nuke prints the following information to the console:

Memory: over maximum usage, trying to reduce usage from 1 GB to 924 MB.

If this variable is not set, you cannot see the debug memory messages.

Note that here, KB, MB, GB, and TB mean units of 1000. For example, 1MB means 1,000,000 bytes.

NUKE_DISK_CACHE

The location where Nuke saves all recent images displayed in the Viewer. Ideally, this should be a local disk with the fastest access time available.

NUKE_DISK_CACHE_GB

The maximum size the disk cache can reach (in gigabytes).

NUKE_EXR_TEMP_DIR

On Linux, this is the location Nuke uses for temporary files while reading PIZ-compressed .exr files. This environment variable is only relevant on Linux.

If this variable is not set, the location is determined by NUKE_TEMP_DIR.

NUKE_FONT_PATH

The location that Nuke checks for available font files when the Text node properties panel is opened.

NUKE_IGNORE_ROTO_INCOMPATIBILITY

This variable disables the warning dialog displayed when you open scripts containing pre-Nuke 8 RotoPaint nodes.

NUKE_INTERACTIVE

The import nuke function checks-out a nuke_r render license by default. If you want to use Nuke interactively, and you have an interactive license, set this environment variable to 1.

See Nuke as a Python Module for more information.

NUKE_MOV64READER_ENABLE

Set this variable to 0 to disable Nuke's 64-bit mov decoding and fall back to 32-bit decoding.

NUKE_NO_CRASH_PROMPT

When crash handling is enabled in GUI mode, this allows you to control whether reports are automatically submitted or not:

When NUKE_NO_CRASH_PROMPT is set to 1, crash reports are submitted automatically without displaying a crash reporter dialog.

When NUKE_NO_CRASH_PROMPT is set to 0, Nuke always displays a crash reporter dialog before submitting a crash report.

NUKE_NO_VIEWER_GPU

Disables Nuke's Comp Viewer OpenGL hardware acceleration.

NUKE_PATH

The location where files related to Nuke customizations are stored. For more information, see Loading Gizmos, NDK Plug-ins, and Python and Tcl Scripts.

NUKE_TEMP_DIR

The location where Nuke saves any temporary files that do not have a particular place defined for them.

NUKE_WINDOWMANAGER_DEBUG

When enabled, data from Nuke's window manager is printed to the command line or Terminal.

OCIO

Set this variable to the location of your OCIO configuration file for color conversion.

NOTE:  If you plan to use the OCIO config file specified in the Preferences, ensure that the Preferences > Project Defaults > Color Management > Export > use OCIO nodes when exportingto a Comp checkbox is enabled.

OFX_PLUGIN_PATH

The location where Nuke looks for OFX plug-ins. For more information, see Loading OFX Plug-ins.