Run a subprocess with custom env and cwd

A subprocess normally inherits the environment variables and working directory of its parent. The spawn options can override both, which is useful for passing configuration to a child or running a tool inside a specific directory. The child here is ende eval, so the example is portable.

Edit on GitHub

Ende.spawn takes the command, its arguments, and options. The env option adds variables on top of the inherited environment, and the child’s stdout stream offers the same convenience methods as a fetch Response.

const withEnv = Ende.spawn(Ende.execPath(), [
  "eval",
  `console.log(Ende.env.get("GREETING"))`
], {
  env: { GREETING: "hello from parent" },
  stdout: "piped"
});

console.log((await withEnv.stdout.text()).trim()); // hello from parent
await withEnv.status;

With clearEnv set to true the child does not inherit anything, it only gets the variables listed in env. Even PATH is gone, so this is best combined with an absolute path to the executable. Note that the operating system may still inject a few variables of its own.

const cleared = Ende.spawn(Ende.execPath(), [
  "eval",
  `console.log("has PATH:", Ende.env.has("PATH"))`
], {
  clearEnv: true,
  env: { GREETING: "hello again" },
  stdout: "piped"
});

console.log((await cleared.stdout.text()).trim()); // has PATH: false
await cleared.status;

The cwd option sets the working directory the child starts in. The child reports its own Ende.cwd() to prove it. Ende.spawnAndWait runs the command to completion and collects everything in one call.

const withCwd = await Ende.spawnAndWait(Ende.execPath(), [
  "eval",
  "console.log(Ende.cwd())"
], {
  cwd: "/",
  stdout: "piped"
});

console.log(new TextDecoder().decode(withCwd.stdout).trim()); // /

The parent’s own working directory is untouched by the child’s cwd.

console.log(Ende.cwd() === "/"); // false

The same options exist on the underlying Ende.Command API, which is the right tool when you need to configure a command before spawning it.

Run this example locally using the Ende CLI:

ende run --allow-run https://docs.ende.sh/examples/scripts/subprocess_env_cwd.ts

Run a subprocess with custom env and cwd

Additional resources