Exec

The Exec resource allows you to execute shell commands as part of your Alchemy infrastructure code.

Minimal Example

Execute a simple shell command:

import { Exec } from "alchemy/os";

const result = await Exec("list-files", {
  command: "ls -la"
});

console.log(result.stdout);

Working Directory and Environment

Run a command in a specific directory with custom environment variables:

import { Exec } from "alchemy/os";

const build = await Exec("build-project", {
  command: "npm run build",
  cwd: "./my-project", 
  env: {
    NODE_ENV: "production"
  }
});

Command Memoization

Cache command output and only re-run when the command changes:

import { Exec } from "alchemy/os";

const status = await Exec("git-status", {
  command: "git status",
  memoize: true
});

// Won't re-run the command if nothing changed
const cachedStatus = await Exec("git-status", {
  command: "git status", 
  memoize: true
});

Error Handling

Control error behavior with throwOnError:

import { Exec } from "alchemy/os";

const result = await Exec("risky-command", {
  command: "some-command-that-might-fail",
  throwOnError: true,
  maxBuffer: 10 * 1024 * 1024 // 10MB buffer
});

if (result.exitCode !== 0) {
  console.error(result.stderr);
}