Method computeEnv

internal/devbox/devbox.go:704–833

computeEnv computes the set of environment variables that define a Devbox environment. The "devbox run" and "devbox shell" commands source these variables into a shell before executing a command or showing an interactive prompt. The process for building the environment involves layering sets of env

(
	ctx context.Context,
	usePrintDevEnvCache bool,
	envOpts devopt.EnvOptions,
)

// some additional processing. The computeEnv environment won't necessarily
// represent the final "devbox run" or "devbox shell" environments.
func (d *Devbox) computeEnv(
	ctx context.Context,
	usePrintDevEnvCache bool,
	envOpts devopt.EnvOptions,
) (map[string]string, error) {
	defer debug.FunctionTimer().End()
	defer trace.StartRegion(ctx, "devboxComputeEnv").End()

	// Append variables from current env if --pure is not passed
	currentEnv := os.Environ()
	env, err := d.parseEnvAndExcludeSpecialCases(currentEnv, envOpts.Pure)
	if err != nil {
		return nil, err
	}

	// check if contents of .envrc is old and print warning
	if !usePrintDevEnvCache {
		err := d.checkOldEnvrc()
		if err != nil {
			return nil, err
		}
	}

	slog.Debug("current environment PATH", "path", env["PATH"])

	originalEnv := make(map[string]string, len(env))
	maps.Copy(originalEnv, env)

	if !envOpts.OmitNixEnv {
		nixEnv, err := d.execPrintDevEnv(ctx, usePrintDevEnvCache)
		if err != nil {
			return nil, err
		}

		for k, v := range nixEnv {
			env[k] = v
		}
	}
	slog.Debug("nix environment PATH", "path", env["PATH"])

	env["PATH"] = envpath.JoinPathLists(
		nix.ProfileBinPath(d.projectDir),
		env["PATH"],
	)

	wd, err := os.Getwd()
	if err != nil {
		return nil, err
	}

	// Add helpful env vars for a Devbox project
	env["DEVBOX_PROJECT_ROOT"] = d.projectDir
	env["DEVBOX_WD"] = wd
	env["DEVBOX_CONFIG_DIR"] = d.projectDir + "/devbox.d"
	env["DEVBOX_PACKAGES_DIR"] = d.projectDir + "/" + nix.ProfilePath

	// Include env variables in devbox.json
	configEnv, err := d.configEnvs(ctx, env)