Skip to main content
A command executed in a Sandbox. For detached commands, you can wait to get a CommandFinished instance with the populated exit code. For non-detached commands, Sandbox.runCommand automatically waits and returns a CommandFinished instance. You can iterate over command output with logs.

​
See

Sandbox.runCommand to start a command.

​
Extended by

​
Properties

​
exitCode

exitCode: null | number;

​
Accessors

​
cmdId

​
Get Signature

get cmdId(): string;
ID of the command execution.
Returns
string

​
cwd

​
Get Signature

get cwd(): string;
Returns
string

​
startedAt

​
Get Signature

get startedAt(): number;
Returns
number

​
Methods

​
logs()

logs(opts?: {
  signal?: AbortSignal;
}): AsyncGenerator<{
  stream: "stdout" | "stderr";
  data: string;
}, void, void> & Disposable & {
  close: void;
};
Iterate over the output of this command. 
for await (const log of cmd.logs()) {
  if (log.stream === "stdout") {
    process.stdout.write(log.data);
  } else {
    process.stderr.write(log.data);
  }
}

​
Parameters

ParameterTypeDescription
opts?{ signal?: AbortSignal; }Optional parameters.
opts.signal?AbortSignalAn AbortSignal to cancel log streaming.

​
Returns

AsyncGenerator<{ stream: "stdout" | "stderr"; data: string; }, void, void> & Disposable & { close: void; } An async iterable of log entries from the command output.

​
See

Command.stdout, Command.stderr, and Command.output to access output as a string.

​
wait()

wait(params?: {
  signal?: AbortSignal;
}): Promise<CommandFinished>;
Wait for a command to exit and populate its exit code. This method is useful for detached commands where you need to wait for completion. For non-detached commands, Sandbox.runCommand automatically waits and returns a CommandFinished instance. 
const detachedCmd = await sandbox.runCommand({
  cmd: "sleep",
  args: ["5"],
  detached: true,
});
const result = await detachedCmd.wait();
if (result.exitCode !== 0) {
  console.error("Something went wrong...");
}

​
Parameters

ParameterTypeDescription
params?{ signal?: AbortSignal; }Optional parameters.
params.signal?AbortSignalAn AbortSignal to cancel waiting.

​
Returns

Promise<CommandFinished> A CommandFinished instance with populated exit code.

​
output()

output(stream: "stdout" | "stderr" | "both", opts?: {
  signal?: AbortSignal;
}): Promise<string>;
Get the output of stdout, stderr, or both as a string. NOTE: This may throw string conversion errors if the command does not output valid Unicode.

​
Parameters

ParameterTypeDefault valueDescription
stream"stdout" | "stderr" | "both""both"The output stream to read: “stdout”, “stderr”, or “both”.
opts?{ signal?: AbortSignal; }undefinedOptional parameters.
opts.signal?AbortSignalundefinedAn AbortSignal to cancel output streaming.

​
Returns

Promise<string> The output of the specified stream(s) as a string.

​
stdout()

stdout(opts?: {
  signal?: AbortSignal;
}): Promise<string>;
Get the output of stdout as a string. NOTE: This may throw string conversion errors if the command does not output valid Unicode.

​
Parameters

ParameterTypeDescription
opts?{ signal?: AbortSignal; }Optional parameters.
opts.signal?AbortSignalAn AbortSignal to cancel output streaming.

​
Returns

Promise<string> The standard output of the command.

​
stderr()

stderr(opts?: {
  signal?: AbortSignal;
}): Promise<string>;
Get the output of stderr as a string. NOTE: This may throw string conversion errors if the command does not output valid Unicode.

​
Parameters

ParameterTypeDescription
opts?{ signal?: AbortSignal; }Optional parameters.
opts.signal?AbortSignalAn AbortSignal to cancel output streaming.

​
Returns

Promise<string> The standard error output of the command.

​
kill()

kill(signal?: Signal, opts?: {
  abortSignal?: AbortSignal;
}): Promise<void>;
Kill a running command in a sandbox.

​
Parameters

ParameterTypeDescription
signal?SignalThe signal to send the running process. Defaults to SIGTERM.
opts?{ abortSignal?: AbortSignal; }Optional parameters.
opts.abortSignal?AbortSignalAn AbortSignal to cancel the kill operation.

​
Returns

Promise<void> Promise<void>.