Method RunScript

internal/devbox/devbox.go:263–342

(ctx context.Context, envOpts devopt.EnvOptions, cmdName string, cmdArgs []string)

}

func (d *Devbox) RunScript(ctx context.Context, envOpts devopt.EnvOptions, cmdName string, cmdArgs []string) error {
	ctx, task := trace.NewTask(ctx, "devboxRun")
	defer task.End()

	if err := shellgen.WriteScriptsToFiles(d); err != nil {
		return err
	}

	lock.SetIgnoreShellMismatch(true)

	var env map[string]string
	if d.IsEnvEnabled() {
		// Skip ensureStateIsUpToDate if we are already in a shell of this devbox-project
		env = envir.PairsToMap(os.Environ())

		// We set this to ensure that init-hooks do NOT re-run. They would have
		// run when initializing the Devbox Environment in the current shell.
		env[d.SkipInitHookEnvName()] = "true"
	} else {
		var err error
		env, err = d.ensureStateIsUpToDateAndComputeEnv(ctx, envOpts)
		if err != nil {
			return err
		}
	}

	// Used to determine whether we're inside a shell (e.g. to prevent shell inception)
	// This is temporary because StartServices() needs it but should be replaced with
	// better alternative since devbox run and devbox shell are not the same.
	env["DEVBOX_SHELL_ENABLED"] = "1"

	// wrap the arg in double-quotes, and escape any double-quotes inside it.
	//
	// TODO(gcurtis): this breaks quote-removal in parameter expansion,
	// command substitution, and arithmetic expansion:
	//
	//	$ unset x
	//	$ echo ${x:-"my file"}
	//	my file
	//	$ devbox run -- echo '${x:-"my file"}'
	//	"my file"
	for idx, arg := range cmdArgs {
		cmdArgs[idx] = strconv.Quote(arg)
	}

	var cmdWithArgs []string
	if _, ok := d.cfg.Scripts()[cmdName]; ok {
		// it's a script, so replace the command with the script file's path.
		script := shellgen.ScriptPath(d.ProjectDir(), cmdName)
		cmdWithArgs = append([]string{strconv.Quote(script)}, cmdArgs...)
	} else {
		// Arbitrary commands should also run the hooks, so we write them to a file as well. However, if the
		// command args include env variable evaluations, then they'll be evaluated _before_ the hooks run,
		// which we don't want. So, one solution is to write the entire command and its arguments into the
		// file itself, but that may not be great if the variables contain sensitive information. Instead,
		// we save the entire command (with args) into the DEVBOX_RUN_CMD var, and then the script evals it.
		//
		// If cmdName is an alias defined in devbox.json, expand it to its command