Skip to main content

Environment variables

orun uses a small set of environment variables for configuration and runtime context.

Variables that affect CLI behavior

VariableMeaning
ORUN_CONFIG_DIRDefault value for the global --config-dir legacy fallback
ORUN_RUNNERDefault runner for orun run
ORUN_EXEC_IDExecution ID injected into orun run; useful in CI for stable cross-job traceability
ORUN_PLAN_IDPlan reference injected into orun run; overrides the default latest resolution
ORUN_NO_COLORDisable ANSI color output (any non-empty value)
ORUN_REMOTE_STATESet to true to enable remote state coordination via orun-backend
ORUN_BACKEND_URLURL of the orun-backend instance (required when ORUN_REMOTE_STATE=true)
ORUN_TOKENStatic API token for orun-backend authentication. Fallback only — in GitHub Actions, OIDC is used automatically and is the required auth method for the live backend's mutable operations
GITHUB_ACTIONSCauses run to auto-select the GitHub Actions backend when set to true
GITHUB_WORKSPACEUsed as the default workdir for the GitHub Actions backend when --workdir is not set

NO_COLOR (the standard) and CLICOLOR=0 are also honored for disabling color output. When color is disabled, the context banner printed during auto-scoping uses plain text without ANSI codes.

Variables injected during execution

VariableMeaning
ORUN_CONTEXTRuntime environment label such as local, container, or ci
ORUN_RUNNERResolved runner name for the current step
ORUN_PLAN_IDPlan checksum short-hash (injected into every step environment)
ORUN_JOB_IDJob ID of the currently running job (e.g. api@dev.deploy)
ORUN_JOB_RUN_IDStable cross-job identifier: {planID}:{execID}:{jobID}

GitHub Actions compatibility mode

When the GitHub Actions backend is active, orun also supports standard GitHub Actions workflow command behavior such as GITHUB_ENV, GITHUB_OUTPUT, and GITHUB_PATH handling inside the compatibility engine.

Prefer CLI flags when you need per-command overrides, and reserve environment variables for CI defaults or workspace-wide configuration.

Most new workflows should declare composition sources in intent.yaml instead of relying on ORUN_CONFIG_DIR.