Skip to main content

​
Environment variables

gensparx pulls environment variables from multiple sources. The rule is never override existing values.

​
Precedence (highest → lowest)

  1. Process environment (what the Gateway process already has from the parent shell/daemon).
  2. .env in the current working directory (dotenv default; does not override).
  3. Global .env at ~/.gensparx/.env (aka $GENSPARX_STATE_DIR/.env; does not override).
  4. Config env block in ~/.gensparx/gensparx.json (applied only if missing).
  5. Optional login-shell import (env.shellEnv.enabled or GENSPARX_LOAD_SHELL_ENV=1), applied only for missing expected keys.
If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.

​
Config env block

Two equivalent ways to set inline env vars (both are non-overriding): 
{
  env: {
    OPENROUTER_API_KEY: "sk-or-...",
    vars: {
      GROQ_API_KEY: "gsk-...",
    },
  },
}

​
Shell env import

env.shellEnv runs your login shell and imports only missing expected keys: 
{
  env: {
    shellEnv: {
      enabled: true,
      timeoutMs: 15000,
    },
  },
}
Env var equivalents:
  • GENSPARX_LOAD_SHELL_ENV=1
  • GENSPARX_SHELL_ENV_TIMEOUT_MS=15000

​
Runtime-injected env vars

gensparx also injects context markers into spawned child processes:
  • GENSPARX_SHELL=exec: set for commands run through the exec tool.
  • GENSPARX_SHELL=acp: set for ACP runtime backend process spawns (for example acpx).
  • GENSPARX_SHELL=acp-client: set for gensparx acp client when it spawns the ACP bridge process.
  • GENSPARX_SHELL=tui-local: set for local TUI ! shell commands.
These are runtime markers (not required user config). They can be used in shell/profile logic to apply context-specific rules.

​
Env var substitution in config

You can reference env vars directly in config string values using ${VAR_NAME} syntax: 
{
  models: {
    providers: {
      "vercel-gateway": {
        apiKey: "${VERCEL_GATEWAY_API_KEY}",
      },
    },
  },
}
See Configuration: Env var substitution for full details.

​
Secret refs vs ${ENV} strings

gensparx supports two env-driven patterns:
  • ${VAR} string substitution in config values.
  • SecretRef objects ({ source: "env", provider: "default", id: "VAR" }) for fields that support secrets references.
Both resolve from process env at activation time. SecretRef details are documented in Secrets Management.
VariablePurpose
GENSPARX_HOMEOverride the home directory used for all internal path resolution (~/.gensparx/, agent dirs, sessions, credentials). Useful when running gensparx as a dedicated service user.
GENSPARX_STATE_DIROverride the state directory (default ~/.gensparx).
GENSPARX_CONFIG_PATHOverride the config file path (default ~/.gensparx/gensparx.json).

​
Logging

VariablePurpose
GENSPARX_LOG_LEVELOverride log level for both file and console (e.g. debug, trace). Takes precedence over logging.level and logging.consoleLevel in config. Invalid values are ignored with a warning.

​
GENSPARX_HOME

When set, GENSPARX_HOME replaces the system home directory ($HOME / os.homedir()) for all internal path resolution. This enables full filesystem isolation for headless service accounts. Precedence: GENSPARX_HOME > $HOME > USERPROFILE > os.homedir() Example (macOS LaunchDaemon): 
<key>EnvironmentVariables</key>
<dict>
  <key>GENSPARX_HOME</key>
  <string>/Users/kira</string>
</dict>
GENSPARX_HOME can also be set to a tilde path (e.g. ~/svc), which gets expanded using $HOME before use.