Environment Variables¶
These variables control how K-Pipe behaves at runtime. Set them in your shell profile or the artist's launcher environment.
| Variable | Required | Description |
|---|---|---|
KPIPE_ROOT |
Yes | Absolute path to the pipeline root directory (where the project files live) |
KPIPE_CONFIG |
No | Config bundle name under configs/ — defaults to main |
KPIPE_ENV |
Yes (DCC) | Path to the Python venv site-packages, injected into DCC's PYTHONPATH at startup |
KPIPE_DEBUG |
No | Set to 1 to enable debug logging |
OCIO |
No | Path to the ACES/OCIO config file for color-managed DCCs |
Example (PowerShell)¶
$env:KPIPE_ROOT = "Z:/projects/doris"
$env:KPIPE_CONFIG = "doris_preprod"
$env:KPIPE_ENV = "C:/Users/artist/.pyenv/versions/3.11.9/envs/kpipe/Lib/site-packages"
$env:OCIO = "Z:/pipeline/k-pipe/configs/ocio/blender_config.ocio"
Tip
The DCC launchers (kpipe-blender, kpipe-nuke, …) set KPIPE_ENV automatically based on the active Poetry environment. Artists don't need to set it manually if they launch through the provided launchers.