Environment variables
Datzi pulls environment variables from multiple sources. The rule is never override existing values.Precedence (highest → lowest)
- Process environment (what the Gateway process already has from the parent shell/daemon).
.envin the current working directory (dotenv default; does not override).- Global
.envat~/.datzi/.env(aka$DATZI_STATE_DIR/.env; does not override). - Config
envblock in~/.datzi/datzi.json(applied only if missing). - Optional login-shell import (
env.shellEnv.enabledorDATZI_LOAD_SHELL_ENV=1), applied only for missing expected keys.
Config env block
Two equivalent ways to set inline env vars (both are non-overriding):
Shell env import
env.shellEnv runs your login shell and imports only missing expected keys:
DATZI_LOAD_SHELL_ENV=1DATZI_SHELL_ENV_TIMEOUT_MS=15000
Env var substitution in config
You can reference env vars directly in config string values using${VAR_NAME} syntax:
Path-related env vars
| Variable | Purpose |
|---|---|
DATZI_HOME | Override the home directory used for all internal path resolution (~/.datzi/, agent dirs, sessions, credentials). Useful when running Datzi as a dedicated service user. |
DATZI_STATE_DIR | Override the state directory (default ~/.datzi). |
DATZI_CONFIG_PATH | Override the config file path (default ~/.datzi/datzi.json). |
DATZI_HOME
When set, DATZI_HOME replaces the system home directory ($HOME / os.homedir()) for all internal path
resolution. This enables full filesystem isolation for headless service accounts.
Precedence: DATZI_HOME > $HOME > USERPROFILE > os.homedir()
Example (macOS LaunchDaemon):
DATZI_HOME can also be set to a tilde path (e.g. ~/svc), which gets expanded using $HOME before use.
