ReferenceStablesince v0.9.2

Environment variables

Every NS_* variable the library reads at runtime — name, type, default, and effect.

Audience: Operators and CI authorsRead: 4 min

Environment variables are the third layer of configuration resolution — after code and before file-based defaults. They are convenient for CI and containers where writing a config file would be noisy.

Precedence

Reference table

NameTypeDefaultEffect
NS_CACHE_DIRpath~/.cache/neuronscopeWhere the recorder spools intermediate observations and where readers cache decoded tensors.
NS_LOG_LEVELstringwarningRoot logger level. One of debug, info, warning, error, critical.
NS_DETERMINISTICboolfalseRefuses to run a recording if any installed op is known non-deterministic.
NS_MAX_OVERHEAD_PCTint20Aborts a recording if measured overhead exceeds the percentage, before sealing.
NS_ARTIFACT_COMPRESSstringzstdCompression codec for .nsz observations. One of zstd, deflate, none.
NS_STORAGE_URLurlfile://.Default artifact destination — file, s3, gs, or azure scheme.
NS_PLUGIN_PATHpath[]Colon-separated extra directories the plugin loader scans.
NS_TELEMETRYboolfalseOpt-in anonymous crash reports. Off by default; nothing leaves the machine unless enabled.
NS_COLORstringautoCLI color mode. One of auto, always, never.
Related